classnames-rails-view 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66300520b93ecc59aa4421dd0412d4a907ea7921
+  data.tar.gz: aebcc014d62732d5ff8e792e707e80586d01b8d8
+SHA512:
+  metadata.gz: 93b15b233c5aeb74e3252cff496cb852d626f3c17502122f32f0b6d340d45677bd942b9373bff5eb1fc39985aa8fd986a590a3c69d4e4ed260db4f24460c0a14
+  data.tar.gz: 94b4a4e568a055f41225d7d2ebd28664f314fbeaf327a35191a7232e2130a2c0de2898b79febeed97ebed4cf4f00532339224ce88ad49f29264ea0a6058b5bf2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Masamoto Miyata
+
+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 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/README.md

@@ -0,0 +1,72 @@
+# Classnames::Rails::View
+This is a view helper that dynamically generates class attributes in Rails view, like [JedWatson/classnames](https://github.com/JedWatson/classnames).
+
+## Usage
+
+The Helper method is included automatically, so you can use it immediately.
+
+```erb
+<div class="<%= classNames('foo') %>">Hello World</div>
+<%# <div class="foo">Hello World</div> %>
+```
+
+The `classNames` method takes any number of arguments which can be a string or hash.
+The argument `'foo'` is short for `{ foo: true }`. If the value associated with a given key is falsy, that key won't be included in the output.
+
+```js
+classNames('foo', 'bar'); // => 'foo bar'
+classNames('foo', { bar: true }); // => 'foo bar'
+classNames({ 'foo-bar': true }); // => 'foo-bar'
+classNames({ 'foo-bar': false }); // => ''
+classNames({ foo: true }, { bar: true }); // => 'foo bar'
+classNames({ foo: true, bar: true }); // => 'foo bar'
+
+// lots of arguments of various types
+classNames('foo', { bar: true, duck: false }, 'baz', { quux: true }); // => 'foo bar baz quux'
+
+// other falsy values are just ignored
+classNames(null, false, 'bar', undefined, 0, 1, { baz: null }, ''); // => 'bar 1'
+```
+
+Arrays will be recursively flattened as per the rules above:
+
+```js
+var arr = ['b', { c: true, d: false }];
+classNames('a', arr); // => 'a b c'
+```
+
+### Change the method name
+
+If you want to change the method name, you can change it with config when starting the application.
+
+```rb
+# config/application.rb
+class Application < Rails::Application
+  ...
+  config.classnames_rails_view.method_name = :classes
+end
+```
+
+```erb
+<div class="<%= classes('foo') %>">Hello World</div>
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'classnames-rails-view'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Contributing
+
+* The test uses Rspec. Please execute the test with `rspec` command.
+* Please code check with [rubocop](https://github.com/bbatsov/rubocop).
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Classnames::Rails::View'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/classnames/rails/view.rb

@@ -0,0 +1,9 @@
+module Classnames
+  module Rails
+    module View
+    end
+  end
+end
+
+require 'classnames/rails/view/core'
+require 'classnames/rails/view/railtie'

data/lib/classnames/rails/view/action_view.rb

@@ -0,0 +1,22 @@
+module Classnames
+  module Rails
+    module View
+      module Helper
+        extend ActiveSupport::Concern
+
+        included do
+          include Classnames::Rails::View::Helper::LocalInstanceMethods
+        end
+
+        module LocalInstanceMethods
+          classnames = Classnames::Rails::View::Core.new
+          define_method ::Rails.application.config.classnames_rails_view.method_name do |*args|
+            classnames.exec(*args)
+          end
+        end
+      end
+    end
+  end
+end
+
+ActionView::Base.send :include, Classnames::Rails::View::Helper

data/lib/classnames/rails/view/core.rb

@@ -0,0 +1,34 @@
+module Classnames
+  module Rails
+    module View
+      class Core
+        def exec(*args)
+          inject_values args
+        end
+
+        private
+
+          def detect_elem(elem)
+            if elem.is_a?(Hash)
+              elem.inject '' do |out, (key, value)|
+                value ? out << key.to_s << ' ' : out
+              end.strip
+            elsif elem.is_a?(Array)
+              inject_values elem
+            elsif elem == false
+              ''
+            else
+              elem.to_s
+            end
+          end
+
+          def inject_values(values)
+            values.inject '' do |out, value|
+              detected = detect_elem(value)
+              detected == '' ? out : out << detect_elem(value) << ' '
+            end.strip
+          end
+      end
+    end
+  end
+end

data/lib/classnames/rails/view/railtie.rb

@@ -0,0 +1,14 @@
+module Classnames
+  module Rails
+    module View
+      class Railtie < ::Rails::Railtie
+        config.classnames_rails_view = ActiveSupport::OrderedOptions.new
+        config.classnames_rails_view.method_name = :classNames
+
+        config.after_initialize do |_app|
+          require 'classnames/rails/view/action_view'
+        end
+      end
+    end
+  end
+end

data/lib/classnames/rails/view/version.rb

@@ -0,0 +1,7 @@
+module Classnames
+  module Rails
+    module View
+      VERSION = '0.1.0'.freeze
+    end
+  end
+end

data/lib/tasks/classnames/rails/view_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :classnames_rails_view do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: classnames-rails-view
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masamoto Miyata
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails-controller-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Make methods similar to Javascript 's classnames available in the rails
+  erb template.
+email:
+- miyata@sincere-co.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/classnames/rails/view.rb
+- lib/classnames/rails/view/action_view.rb
+- lib/classnames/rails/view/core.rb
+- lib/classnames/rails/view/railtie.rb
+- lib/classnames/rails/view/version.rb
+- lib/tasks/classnames/rails/view_tasks.rake
+homepage: https://github.com/gomo/classnames-rails-view
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: The helper method to dynamically generate class attribute of HTML tag.
+test_files: []