Githubで公開されている機能をRailsで使用したい

Question

前提・実現したいこと

GitHubで公開されているこちらの機能をRailsアプリで使用したいです。
https://github.com/lazaronixon/trix-extensions

Rails6のActionTextに使われているTrixの拡張機能？のようなものです。

発生している問題

GitHubについては自分がデプロイするためにしか使ったことがないため、公開されているものを自分のアプリで使用する方法がわかりません。
おそらくかなり基本的なことなのだとは思うのですが、どう調べていいのかわからず調べてもGitHubの導入の仕方ばかり出てきてしまい目的の情報に辿り着けません。

試したこと

git clone 「CodeボタンのClone欄のurl」
でインストールできると書いてあるサイトがあったので、アプリのディレクトリで
git clone https://github.com/lazaronixon/trix-extensions
と入力したところ

Cloning into 'trix-extensions'...
remote: Enumerating objects: 34, done.
remote: Counting objects: 100% (34/34), done.
remote: Compressing objects: 100% (22/22), done.
remote: Total 34 (delta 5), reused 32 (delta 3), pack-reused 0
Receiving objects: 100% (34/34), 5.57 KiB | 2.78 MiB/s, done.
Resolving deltas: 100% (5/5), done.

と表示されアプリに必要なものがインストールされたようなのですが、変化はありませんでした。

zipでダウンロードしてみましたが、複数あるファイルの中のどのファイルをどこに入れればいいのかがわからないです。

仕組みを把握できていないためかなり曖昧な質問の仕方になってしまいましたがご教授いただけますと幸いです。

###追記
ダウンロードしたzipファイルと同じものがアプリのトップディレクトリにあったため、git cloneがファイル（trix-extentions）を丸ごとディレクトリに持ってくるものであることは理解しました。

Comments

[maisumakun]

Gemとして上がっているかは探してみましたか？

[takamaru_ss]

gem trix-extensionsで検索してみましたがrdf-trixというものしかヒットしないです。
こちらはデータの解析やグラフ表示に関するgemなようなので今回のもの（テキストエディタに色付け機能などを追加するもの）とは別物なようです。

Answer 1

Github(であれどのgit repositoryであれ)にある一般的ライブラリをそのままRailsから利用する一般的方法は存在しません。理由は、git repositoryにあがっているソースをどうRailsに組み込むかは、それぞれのソースによって異なるからです。

ただし、Githubにあがっているのが、RubyのGem形式になっている場合に限っては簡単で、Gemfileに以下のように記載すればよいです。ここで、name_of… がそのGemやgithubのディレクトリ名です。

gem 'name_of_your_gem', '~> 0', '>= 0.1', git: 'https://github.com/SOMEONE/NAME_OF_YOUR_GEM_SOURCE'

使おうとしているtrix-extensionsの場合、Gemのディレクトリ構造になっていないようですね。したがって、この方法は使えません。言い換えれば、trix-extensions は、そのまま Railsで使える形にはなっていません。

対策ですが、理想的には、そのGithubのソースを自分でforkして、自分でRailsのパッケージ(つまりRubyのGem)にするよう書き換えることが最善です。こうすれば、基のソースに変更があった場合、それをforkした自分のGemに反映するためのフレームワークが整っていることになりますから。

Railsの公式ガイドに従ってプログラミングしていけばよいでしょう。
ただし、相当高度であり、そのためのRubyのコードをたくさん書く必要があります。自分でRails用のGemを開発するわけですから。

そこまでしたくはなくて、とにかく、現在バージョンでいいから、なりふり構わずそのGithubのソースを自分の開発中のRailsアプリに組込みたい、という場合は、そのソースを取ってきて(git cloneでもいいし、zip fileをダウンロードしてもいい)、それを自分のRailsのアプリのディレクトリの中に直接コピーすれば可能です。単純に cp を使ったりあるいはドラッグ・アンド・ドロップでコピーしても構いません。もしくは、ターミナルで rsync を使えば、もう少しエレガントにできます。たとえば、以下でいけるのではと思います(試していませんが)。最初のパスが取ってきたソース、最後のパスが開発中のRailsのアプリです。

rsync -av --exclude=LICENSE --exclude=README.md /YOUR_DIR/trix-extensions/ /YOUR/RAILS/DIR/YOUR_APP

rsyncの使用法の詳しくは、man rsyncなどでチェックしてみてください。tipsとして、思わぬ副作用を避けるためには、-n や -u オプションは特に有用です。

Githubのソースを見ると、この場合はファイル数は大したことない様子なので、rsyncを使うことなく単にcpで一つ一つコピーしても十分でしょうか。

Comments

[takamaru_ss]

ありがとうございます。

zipファイルの中身をそれぞれのディレクトリに移動させてimportした上で一部ファイルを書き換えることで対応させることができました。