class_names 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7252ad0407a66b839b7b9b81c5477780bdb3e9a57646c2bd055664cc5ba4f446
+  data.tar.gz: 59e5438cfc0fbed29c787cdaad64c1dbd5092ddd6115165125966a1321bbe8ca
+SHA512:
+  metadata.gz: bc6d44a8725469c947a5888c29dd908d06073b7911e81de1ace8b9d04cc7e28445fb567b0c0d52e972280a9c76962f86509810563dac82114a4152a2cf199971
+  data.tar.gz: 366c3e7ac44d147ccd1080460b67eb06c9124b1bb6e5f7f4ead6b9336f56b62e7046b1df2529a9d34d0dffa26654f2002a8ca5bc8ce29276eede062c6dc6e032

data/.gitignore

@@ -0,0 +1,66 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+### Ruby template
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+### JetBrains template
+.idea/
+

data/.rubocop.yml

@@ -0,0 +1,89 @@
+require:
+  - rubocop-performance
+  - rubocop-rails
+
+AllCops:
+  TargetRubyVersion: 2.3
+  TargetRailsVersion: 4.2
+  Exclude:
+    - db/schema.rb
+    - 'vendor/**/*'
+
+Metrics/LineLength:
+  Max: 125
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+# Wants us to use %w or %W for arrays of strings
+Style/WordArray:
+  Enabled: false
+
+# Adds Rails linting suggestions
+Rails:
+  Enabled: true
+
+# Double quotes > single quotes
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# Explicit return at the end of a method helps with readability
+Style/RedundantReturn:
+  Enabled: false
+
+# We don't usually want to separate our ints with '_' for readability
+Style/NumericLiterals:
+  Enabled: false
+
+# This is a weird suggested syntax, and not as readable
+ConditionalAssignment:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Metrics/MethodLength:
+  Max: 30
+  Exclude:
+    - "db/**/*"
+
+ClassLength:
+  Max: 500
+
+Metrics/ModuleLength:
+  Max: 500
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/ReturnNil:
+  Enabled: true
+  EnforcedStyle: return_nil
+
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/BlockLength:
+  Max: 30
+  Exclude:
+    - "db/**/*"
+    - "test/**/*"
+
+# HttpPositionalArguments doesnt work with rails 4: https://github.com/bbatsov/rubocop/issues/3629
+Rails/HttpPositionalArguments:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in class_names.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    class_names (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.8.5)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  class_names!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -0,0 +1,64 @@
+# ClassNames
+
+ClassNames is a simple helper to conditionally join class names together.
+
+Influenced by: https://www.npmjs.com/package/classnames and https://github.com/nLight/css-class-string
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'class_names'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install class_names
+
+## Usage
+
+Inside of a view:
+
+```html+erb
+  <!-- @conditional = false -->
+  <span class="<%= class_names(some: true, classy: true, [:truthy, :falsy] => @conditional) %>">
+  <!-- equal to -->
+  <span class="<%= class_names('some', 'classy', [:truthy, :falsy] => @conditional %>)">
+  <!-- => <span class="some classy falsy"></span> -->
+```
+
+```haml
+  // @conditional = true
+  %span{class: class_names(some: true, classy: false, [:truthy, :falsy] => @conditional)}
+  // equal to
+  %span{class: class_names('some', falsy: false, [:truthy, :falsy] => @conditional)}
+  // => <span class="some truthy"></span>
+```
+
+Outside of a view:
+
+```
+ClassNames::Helper.new(:str_truthy => true, :str_falsy => false}).to_s
+ => "str_truthy" 
+
+ClassNames::Helper.new("truthy_1", "truthy_2").to_s
+ => "truthy_1 truthy_2"
+
+ClassNames::Helper.new({[:arr_truthy, :arr_falsy] => false}).to_s
+ => "arr_falsy" 
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/abodo-dev/class_names. This project is intended to be a safe, welcoming space for collaboration.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/class_names.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "class_names/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "class_names"
+  spec.version       = ClassNames::VERSION
+  spec.authors       = ["Harris Thompson"]
+  spec.email         = ["hthompson@abodo.com"]
+
+  spec.summary       = %q{A simple helper to conditionally join class names together.}
+  spec.homepage      = "https://github.com/abodo-dev/class_names"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/abodo-dev/class_names"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/class_names.rb

@@ -0,0 +1,2 @@
+require 'class_names/version'
+require 'class_names/railtie' if defined?(Rails)

data/lib/class_names/helper.rb

@@ -0,0 +1,28 @@
+module ClassNames
+  class Helper
+    def initialize(*classes)
+      options = classes.last.is_a?(::Hash) ? classes.pop : {}
+
+      @classes = {}
+      # default to true on class_names("truthy") like calls
+      @classes = classes.map do |class_name|
+        if class_name.is_a?(::Hash)
+          class_name.each do |class_key, class_value|
+            next if !class_value
+            @classes[class_key] = true
+          end
+        else
+           { class_name => true } if class_name
+        end
+      end.compact.reduce({}, &:merge)
+      @classes.merge!(options)
+
+      # handle multiple keys in hash class_names([arr_truthy, arr_falsy] => false) --> "arr_falsy"
+      @classes = @classes.map { |((true_css_key, false_css_key), condition)| condition ? true_css_key : false_css_key }
+    end
+
+    def to_s
+      return @classes.compact.join(" ")
+    end
+  end
+end

data/lib/class_names/railtie.rb

@@ -0,0 +1,9 @@
+require 'class_names/view_helper'
+
+module ClassNames
+  class Railtie < Rails::Railtie
+    initializer "class_names.view_helper" do
+      ActionView::Base.send :include, ViewHelper
+    end
+  end
+end

data/lib/class_names/version.rb

@@ -0,0 +1,3 @@
+module ClassNames
+  VERSION = "0.1.1"
+end

data/lib/class_names/view_helper.rb

@@ -0,0 +1,9 @@
+require "class_names/helper"
+
+module ClassNames
+  module ViewHelper
+    def class_names(*args)
+      ::ClassNames::Helper.new(*args).to_s
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: class_names
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Harris Thompson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- hthompson@abodo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- class_names.gemspec
+- lib/class_names.rb
+- lib/class_names/helper.rb
+- lib/class_names/railtie.rb
+- lib/class_names/version.rb
+- lib/class_names/view_helper.rb
+homepage: https://github.com/abodo-dev/class_names
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/abodo-dev/class_names
+  source_code_uri: https://github.com/abodo-dev/class_names
+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: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: A simple helper to conditionally join class names together.
+test_files: []