trix-editmode 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b14038426199c3db34130c9e9e8a9c94120798c9e3d12d1472b84d3d9bc1a6e
-  data.tar.gz: d1a9d9a19d91004090b83ac35ec1f921db1ef8bc2dea28c5ebe40602473a1df7
+  metadata.gz: 1198953e0578f1507e62dbba3898167f8805d9468e28115952da5bcb2165789e
+  data.tar.gz: 7f12d5cc828fab7adf13725ce31e39d057e2a591ab0e53a723d033177add5d83
 SHA512:
-  metadata.gz: db5469001acc102c4d1d251e809145b2f615c856a8c57a24cf11683cf51e7450a69251aec57cf123f793f55b39382c944f374882cf8a03c2e1687cbc2ba2331d
-  data.tar.gz: 626d107e2a23de657f2e6c347fa73d57bf0a613d7ecdd9cd61557e5834e8e9da2c3ee3696fa121e6a695d46076d17cd839ecae19fc1574d9c3554c8697e41d89
+  metadata.gz: de0108d691d01f19541d68db66119928f4af87763b6459258681260a8cd7cfc27c9f00ffbe0fb396bff8be3a19e7eb0885dc54bc83eb4a98603f684181f6a2bb
+  data.tar.gz: 2e9670722bab97a486a7c796e40e05d9b7d48287a6b470a94a6e8c226fa5e5915059c36f753ee6eabfaa4fae8a4309bc42a7a235db9eb26693f8d032752ef057

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+What did you expect to happen? Be as specific as possible.
+
+**Actual behavior**
+What actually happened? Be as specific as possible.
+
+**Screenshots or Video**
+If applicable, add screenshots or video to help explain your problem.
+
+**Environment (please complete the following information):**
+ - Rails version: x.x.x
+ - trix-rails version: x.x.x
+- Browser:

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 /gemfiles/*.gemfile.lock
 .ruby-version
+*.gem

data/.travis.yml

@@ -1,14 +1,21 @@
 language: ruby
 rvm:
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
+  - 2.3.8
+  - 2.4.7
+  - 2.5.6
+  - 2.6.4
 gemfile:
-  - gemfiles/rails_4.2.gemfile
   - gemfiles/rails_5.0.gemfile
   - gemfiles/rails_5.1.gemfile
+  - gemfiles/rails_5.2.gemfile
+  - gemfiles/rails_5.2.1.gemfile
+  - gemfiles/rails_6.0.0.gemfile
   - gemfiles/rails_master.gemfile
 matrix:
   allow_failures:
     - gemfile: 'gemfiles/rails_master.gemfile'
-before_install: gem install bundler -v 1.11.2
+    - gemfile: gemfiles/rails_6.0.0.gemfile
+      rvm: 2.3.8
+    - gemfile: gemfiles/rails_6.0.0.gemfile
+      rvm: 2.4.7
+before_install: gem install bundler -v '~> 2.0'

data/Appraisals

@@ -1,18 +1,26 @@
-appraise "rails-4.2" do
-  gem "rails", "~> 4.2.0"
+appraise 'rails-5.0' do
+  gem 'rails', '~> 5.0.0'
 end
 
-appraise "rails-5.0" do
-  gem "rails", "~> 5.0.0"
+appraise 'rails-5.1' do
+  gem 'rails', '~> 5.1.0'
 end
 
-appraise "rails-5.1" do
-  gem "rails", "~> 5.1.0"
+appraise 'rails-5.2' do
+  gem 'rails', '~> 5.2.0'
 end
 
-appraise "rails-master" do
-  gem "rails", git: "https://github.com/rails/rails.git", branch: "master"
-  gem "arel", git: "https://github.com/rails/arel.git", branch: "master"
+appraise 'rails-5.2.1' do
+  gem 'rails', '~> 5.2.1'
+end
+
+appraise 'rails-6.0.0' do
+  gem 'rails', '6.0.0'
+end
+
+appraise 'rails-master' do
+  gem 'rails', git: 'https://github.com/rails/rails.git', branch: 'master'
+  gem 'arel', git: 'https://github.com/rails/arel.git', branch: 'master'
   %w[rspec-core rspec-expectations rspec-mocks rspec-rails rspec-support].each do |lib|
     gem lib, git: "https://github.com/rspec/#{lib}.git", branch: 'master'
   end

data/CHANGELOG.md

@@ -0,0 +1,51 @@
+# trix-rails changelog
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## Master
+
+Not released
+
+## 2.2.0
+
+Released September 13, 2019
+
+* ✅ Upgrade to [Trix 1.2.0](https://github.com/basecamp/trix/releases/tag/1.2.0)
+* 💪 Bump to version 2.2.0
+* 🚫 Remove appraisals for Rails 4.2 (support will be removed in trix-rails 3.x)
+
+## 2.1.0
+
+Released September 9, 2019
+
+* 🐛🔨 Add customizable input name for trix-editor in simple form ([#12](https://github.com/kylefox/trix/pull/12)). Thanks [@ptrr](https://github.com/ptrr)!
+* 💪 Modify Gemspec to support Rails 6 ([#17](https://github.com/kylefox/trix/pull/17)). Thanks [@king601](https://github.com/king601)!
+* 💪 Bump to version 2.1.0
+
+## 2.0.0
+
+Released September 29, 2018
+
+* ✅ Upgrade to [Trix 1.0.0](https://github.com/basecamp/trix/releases/tag/1.0.0) 🎉
+* ☝️ Note: following this project's [versioning policy](https://github.com/kylefox/trix/issues/4), the major version for `trix-rails` is likewise bumped when Trix receives a major version bump.
+* 🐛🔨 simple_form helper outputs hidden input tag before trix editor tag ([#10](https://github.com/kylefox/trix/pull/10)). Thanks [@bensie](https://github.com/bensie)!
+* 💪 Add appraisals for Rails 5.2.1
+
+
+## 1.0.1
+
+Released September 20, 2018
+
+* ✅ Upgrade to Trix 0.12.1.
+* 🐛🔨 Formtastic helper outputs hidden input tag before trix editor tag ([#9](https://github.com/kylefox/trix/pull/9)). Thanks [@ch000](https://github.com/ch000)!
+
+## 1.0.0
+
+Released September 2, 2018
+
+* ✅ Bumped to version 1.0.0 — `trix-rails` version numbers are now independent of [Trix](https://github.com/basecamp/trix) itself. See [this issue](https://github.com/kylefox/trix/issues/4) for more detail.
+* ✅ Upgrade to Trix 0.12.0.
+* ✅ Added support for Ruby 2.5.1.
+* 🚫 Dropped support for Ruby 2.2.
+* 🐛🔨 Allow additional options when using simple_form ([#8](https://github.com/kylefox/trix/pull/8)). Thanks [@phylor](https://github.com/phylor)!

data/README.md

@@ -1,26 +1,24 @@
-# Trix
+# Trix for Ruby on Rails
 
-[![Build Status](https://travis-ci.org/maclover7/trix.svg)](https://travis-ci.org/maclover7/trix)
+[![Build Status](https://api.travis-ci.org/kylefox/trix.svg)](https://travis-ci.org/kylefox/trix)
 
 Want to include Basecamp's awesome [Trix WYSIWYG
 editor](http://trix-editor.org) in your Ruby on Rails application?
 You've come to the right place!
 
-Please see the appropriate guide for your environment of choice:
+Compatible with Rails 5.0 and up.
 
-* [Ruby on Rails](#a-ruby-on-rails).
+_Note: trix-rails 2.x is technically compatible with Rails 4.2 and up, but is no longer tested or maintained. Support for < Rails 5.0 will be dropped in trix-rails 3.x_
 
-### a. Ruby on Rails
+# Installation
 
-`trix` is easy to drop into Rails with the asset pipeline.
-
-In your Gemfile you need to add the `trix` gem.
+Add `trix-rails` to your `Gemfile`:
 
 ```ruby
-gem 'trix'
+gem 'trix-rails', require: 'trix'
 ```
 
-`bundle install` and restart your server to make the files available through the pipeline.
+Run `bundle install` and restart your server to make the files available through the pipeline.
 
 Import Trix styles in `app/assets/stylesheets/application.css`:
 
@@ -34,35 +32,92 @@ Require Trix Javascript magic in `app/assets/javascripts/application.js`:
 //= require trix
 ```
 
-Finally, any place where you would like to use the Trix editor in your
-forms, just use the `trix_editor` helper:
+# Usage
+
+You can use `trix-rails` as a standalone tag, in a form builder, or with popular form libraries.
+
+## Standalone Tag
+
+Create a simple `<trix-editor>` tag:
 
 ```ruby
-f.trix_editor :body
+trix_editor_tag(name, value = nil, options = {})
 ```
 
-If you are using the [Formtastic](https://github.com/justinfrench/formtastic) gem or the [Simple Form](https://github.com/plataformatec/simple_form) gem, you can do this:
+For example:
+
+```erb
+<%= trix_editor_tag :post, :body, required: true %>
+```
+
+## Form builder
+
+Create a Trix editor for a `form_for` or `form_with` attribute:
+
+```ruby
+trix_editor(method, options = {})
+```
+
+For example:
+
+```erb
+<%= post_form.trix_editor :body, required: true, autofocus: true %>
+```
+
+## Formtastic and Simple Form
+
+If you're using [Formtastic](https://github.com/justinfrench/formtastic) or [Simple Form](https://github.com/plataformatec/simple_form), you can do this:
 
 ```ruby
 f.input :body, as: :trix_editor
 ```
 
-## Trix
+## Options
 
-For the official Trix Github repository, go
-[here](https://github.com/basecamp/trix).
+Any `options` provided will be passed along to the [`content_tag`](https://api.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-content_tag) call that outputs the `<trix-editor>` tag.
 
-## Contributing
+For example:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/maclover7/trix.
+```erb
+<%= post_form.trix_editor :body, autofocus: true, data: { coffee: :delicious } %>
+```
+
+will render:
+
+```html
+<trix-editor autofocus="true" data-coffee="delicious">
+```
+
+# Contributing
+
+Bug reports and feature requests are welcome. They're _much_ more likely to be addressed if they are accompanied by a pull request 😘
+
+* [Report a bug](https://github.com/kylefox/trix/issues/new?template=bug_report.md)
+* [Request a feature](https://github.com/kylefox/trix/issues/new?template=feature_request.md)
+
+## Testing
+
+All pull requests should include tests, where applicable. Pull requests without tests may be rejected.
+
+`trix-rails` uses [Appraisal](https://github.com/thoughtbot/appraisal) to test against supported versions of Rails. You can run the specs against all supported versions with:
+
+```shell
+bundle exec appraisal rake spec
+```
 
 ## Upgrading Trix
-1. Copy and paste Trix's `trix.js `to `vendor/assets/javascripts/trix.js`
-2. Copy and paste Trix's `trix.css `to `vendor/assets/stylesheets/trix.css`
-3. Update `lib/trix/version.rb` with the correct version number
-4. `git commit -am 'Bump to vVERSION'`
-4. `bundle exec rake release`
 
-## License
+To upgrade Trix, simply copy the _compiled_ styles from [`trix/dist`](https://github.com/basecamp/trix/tree/master/dist) into this repository:
+
+- Copy [`trix.js`](https://raw.githubusercontent.com/basecamp/trix/master/dist/trix.js) to `vendor/assets/javascripts/trix.js`
+- Copy [`trix.css`](https://raw.githubusercontent.com/basecamp/trix/master/dist/trix.css) to `vendor/assets/stylesheets/trix.css`
+
+# License (MIT)
+
+`trix-rails` is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/rails_4.2.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "~> 4.2.0"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_5.0.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "~> 5.0.0"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "~> 5.1.0"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_5.2.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.2.1"
+
+gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_6.0.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "6.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_master.gemfile

@@ -2,12 +2,12 @@
 
 source "https://rubygems.org"
 
-gem "rails", :git => "https://github.com/rails/rails.git", :branch => "master"
-gem "arel", :git => "https://github.com/rails/arel.git", :branch => "master"
-gem "rspec-core", :git => "https://github.com/rspec/rspec-core.git", :branch => "master"
-gem "rspec-expectations", :git => "https://github.com/rspec/rspec-expectations.git", :branch => "master"
-gem "rspec-mocks", :git => "https://github.com/rspec/rspec-mocks.git", :branch => "master"
-gem "rspec-rails", :git => "https://github.com/rspec/rspec-rails.git", :branch => "master"
-gem "rspec-support", :git => "https://github.com/rspec/rspec-support.git", :branch => "master"
+gem "rails", git: "https://github.com/rails/rails.git", branch: "master"
+gem "arel", git: "https://github.com/rails/arel.git", branch: "master"
+gem "rspec-core", git: "https://github.com/rspec/rspec-core.git", branch: "master"
+gem "rspec-expectations", git: "https://github.com/rspec/rspec-expectations.git", branch: "master"
+gem "rspec-mocks", git: "https://github.com/rspec/rspec-mocks.git", branch: "master"
+gem "rspec-rails", git: "https://github.com/rspec/rspec-rails.git", branch: "master"
+gem "rspec-support", git: "https://github.com/rspec/rspec-support.git", branch: "master"
 
-gemspec :path => "../"
+gemspec path: "../"

data/lib/formtastic/inputs/trix_editor_input.rb

@@ -9,7 +9,7 @@ class TrixEditorInput < Formtastic::Inputs::StringInput
       editor_tag = template.content_tag('trix-editor', '', editor_tag_params)
       hidden_field = builder.hidden_field(method, input_html_options)
 
-      editor = template.content_tag('div', editor_tag + hidden_field, class: 'trix-editor-wrapper')
+      editor = template.content_tag('div', hidden_field + editor_tag, class: 'trix-editor-wrapper')
 
       label_html + editor
     end

data/lib/trix/form.rb

@@ -8,13 +8,11 @@ module TrixEditorHelper
   def trix_editor_tag(name, value = nil, options = {})
     options.symbolize_keys!
 
-    css_class = Array.wrap(options[:class]).join(' ')
-    attributes = { class: "formatted_content trix-content #{css_class}".squish }
-    attributes[:autofocus] = true if options[:autofocus]
-    attributes[:input] = options[:input] || "trix_input_#{TrixEditorHelper.id += 1}"
-
-    valid_html_options = [:placeholder, :spellcheck, :toolbar, :tabindex]
-    attributes.merge!(options.slice(*valid_html_options))
+    css_class = Array.wrap(options.delete(:class)).join(' ')
+    attributes = {
+      class: "formatted_content trix-content #{css_class}".squish,
+      input: "trix_input_#{TrixEditorHelper.id += 1}"
+    }.merge(options)
 
     editor_tag = content_tag('trix-editor', '', attributes)
     input_tag = hidden_field_tag(name, value, id: attributes[:input])
@@ -36,7 +34,14 @@ module ActionView
           options = @options.stringify_keys
           add_default_name_and_id(options)
           options['input'] ||= dom_id(object, [options['id'], :trix_input].compact.join('_'))
-          trix_editor_tag(options.delete('name'), value_before_type_cast(object), options)
+
+          value = if Rails.gem_version >= Gem::Version.new('5.2.x')
+                    options.delete('value') { value_before_type_cast }
+                  else
+                    value_before_type_cast(object)
+                  end
+
+          trix_editor_tag(options.delete('name'), value, options)
         end
       end
     end

data/lib/trix/simple_form/trix_editor_input.rb

@@ -2,10 +2,13 @@ module Trix
   module SimpleForm
     class TrixEditorInput < ::SimpleForm::Inputs::Base
       def input(_wrapper_options)
-        editor_tag = template.content_tag('trix-editor', '', input: input_class, class: 'trix-content')
+        trix_options = options.slice(:spellcheck, :toolbar, :tabindex, :input)
+        editor_options = { input: input_class, class: 'trix-content' }.merge(trix_options)
+
+        editor_tag = template.content_tag('trix-editor', '', editor_options)
         hidden_field = @builder.hidden_field(attribute_name, input_html_options)
 
-        template.content_tag('div', editor_tag + hidden_field, class: 'trix-editor-wrapper')
+        template.content_tag('div', hidden_field + editor_tag, class: 'trix-editor-wrapper')
       end
     end
   end