class_names 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7252ad0407a66b839b7b9b81c5477780bdb3e9a57646c2bd055664cc5ba4f446
-  data.tar.gz: 59e5438cfc0fbed29c787cdaad64c1dbd5092ddd6115165125966a1321bbe8ca
+  metadata.gz: b65124636f3d94f9009bfb7709fcc85adcecb2c2ca0e976c214006e2be5d7e02
+  data.tar.gz: a10164f19bd4cea67ce6b8295cc177836f6f7d23c8fdfb409eac02f611b9c473
 SHA512:
-  metadata.gz: bc6d44a8725469c947a5888c29dd908d06073b7911e81de1ace8b9d04cc7e28445fb567b0c0d52e972280a9c76962f86509810563dac82114a4152a2cf199971
-  data.tar.gz: 366c3e7ac44d147ccd1080460b67eb06c9124b1bb6e5f7f4ead6b9336f56b62e7046b1df2529a9d34d0dffa26654f2002a8ca5bc8ce29276eede062c6dc6e032
+  metadata.gz: 780ca3e59e40c200554914de8d580d66cb70c32819a00427053f9132cd772ca59c8b7aa62127607109f9868b704688863d50c1f541ba00688a7e2654b2a2acf3
+  data.tar.gz: f00dba300d98fec3fc6abc3a7e2caad22bba5c2771397c63210e7e0fd08630b0643f320618a5a00b561086690e1f7e17020c5c5cd395c25100a18ebdd52a02b9

data/.github/workflows/gempush.yml

@@ -0,0 +1,44 @@
+name: Ruby Gem
+
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.GPR_AUTH_TOKEN}}
+        OWNER: abodo-dev
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.rubocop.yml

@@ -5,9 +5,6 @@ require:
 AllCops:
   TargetRubyVersion: 2.3
   TargetRailsVersion: 4.2
-  Exclude:
-    - db/schema.rb
-    - 'vendor/**/*'
 
 Metrics/LineLength:
   Max: 125
@@ -50,8 +47,6 @@ Style/SymbolArray:
 
 Metrics/MethodLength:
   Max: 30
-  Exclude:
-    - "db/**/*"
 
 ClassLength:
   Max: 500
@@ -80,10 +75,4 @@ Metrics/PerceivedComplexity:
 
 Metrics/BlockLength:
   Max: 30
-  Exclude:
-    - "db/**/*"
-    - "test/**/*"
-
-# HttpPositionalArguments doesnt work with rails 4: https://github.com/bbatsov/rubocop/issues/3629
-Rails/HttpPositionalArguments:
-  Enabled: false
+    - "test/**/*"

data/Gemfile.lock

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Harris Joseph Thompson
+
+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

@@ -1,5 +1,7 @@
 # ClassNames
 
+[![Gem Version](https://badge.fury.io/rb/class_names.svg)](https://badge.fury.io/rb/class_names)
+
 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
@@ -25,18 +27,42 @@ Or install it yourself as:
 Inside of a view:
 
 ```html+erb
-  <!-- @conditional = false -->
-  <span class="<%= class_names(some: true, classy: true, [:truthy, :falsy] => @conditional) %>">
+  <span class="<%= class_names('foo', 'bar') %>">
+  <!-- => <span class="foo bar"></span> -->
+  
+  <span class="<%= class_names('foo', { bar: true }) %>">
+  <!-- => <span class="foo bar"></span> -->
+  
+  <span class="<%= class_names('foo-bar': true) %>">
+  <!-- => <span class="foo-bar"></span> -->
+  
+  <span class="<%= class_names('foo-bar': false) %>">
+  <!-- => <span class=""></span> -->
+  
+  <span class="<%= class_names(foo: true, bar: true) %>">
+  <!-- => <span class="foo bar"></span> -->
+  
+  <span class="<%= class_names({ foo: true, bar: true }) %>">
+  <!-- => <span class="foo bar"></span> -->
+  
+  <!-- Simple ternary replacement with multiple hashes -->
+  <span class="<%= class_names([:truthy, :falsy] => true) %>">
+  <!-- => <span class="truthy"></span> -->
+  
+  <span class="<%= class_names([:truthy, :falsy] => false) %>">
+  <!-- => <span class="falsy"></span> -->
+  
+  <!-- Lots of different types of arguments -->
+  <span class="<%= class_names(some: true, classy: true, [:truthy, :falsy] => false, 'foo') %>">
   <!-- equal to -->
-  <span class="<%= class_names('some', 'classy', [:truthy, :falsy] => @conditional %>)">
-  <!-- => <span class="some classy falsy"></span> -->
+  <span class="<%= class_names('some', 'classy', [:truthy, :falsy] => false %>, 'foo')">
+  <!-- => <span class="some classy falsy foo"></span> -->
 ```
 
 ```haml
-  // @conditional = true
-  %span{class: class_names(some: true, classy: false, [:truthy, :falsy] => @conditional)}
+  %span{class: class_names(some: true, classy: false, [:truthy, :falsy] => true)}
   // equal to
-  %span{class: class_names('some', falsy: false, [:truthy, :falsy] => @conditional)}
+  %span{class: class_names('some', falsy: false, [:truthy, :falsy] => true)}
   // => <span class="some truthy"></span>
 ```
 
@@ -62,3 +88,13 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## 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.
+
+## Performance
+On 50,000 calls. The unit of time is seconds.
+
+|                                  | user     | system   | total    | real        |
+|----------------------------------|----------|----------|----------|-------------|
+| With 1 array and 1 string value  | 0.660000 | 0.000000 | 0.660000 | (0.657901)  |
+| With 5 array and 5 string values | 0.640000 | 0.000000 | 0.640000 | (0.650673)  |
+| With 10 array values             | 0.450000 | 0.000000 | 0.450000 | (0.449735)  |
+| With 10 string values            | 0.320000 | 0.010000 | 0.330000 | (0.320911)  |

data/class_names.gemspec

@@ -8,7 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Harris Thompson"]
   spec.email         = ["hthompson@abodo.com"]
 
-  spec.summary       = %q{A simple helper to conditionally join class names together.}
+  spec.summary       = %q{A simple helper to conditionally join class names together}
+  spec.description   = %q{The class_names function 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 (nil or false), that key won't be included in the output.}
   spec.homepage      = "https://github.com/abodo-dev/class_names"
   spec.license       = "MIT"
 
@@ -25,6 +26,6 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
 end

data/lib/class_names/helper.rb

@@ -1,11 +1,11 @@
 module ClassNames
   class Helper
-    def initialize(*classes)
-      options = classes.last.is_a?(::Hash) ? classes.pop : {}
+    def initialize(*class_map)
+      options = class_map.last.is_a?(::Hash) ? class_map.pop : {}
 
       @classes = {}
       # default to true on class_names("truthy") like calls
-      @classes = classes.map do |class_name|
+      @classes = class_map.map do |class_name|
         if class_name.is_a?(::Hash)
           class_name.each do |class_key, class_value|
             next if !class_value
@@ -25,4 +25,4 @@ module ClassNames
       return @classes.compact.join(" ")
     end
   end
-end
+end

data/lib/class_names/version.rb

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

data/profiling/benchmark.rb

@@ -0,0 +1,43 @@
+require("benchmark")
+require("securerandom")
+require("class_names/view_helper")
+include ClassNames::ViewHelper
+
+NUMBER_OF_CALLS = 50_000
+
+def class_name
+  SecureRandom.hex(4)
+end
+
+def true_or_false
+  [true, false].sample
+end
+
+arrays = Enumerator.new { |y| y << [[class_name, class_name], true_or_false] }
+strings = Enumerator.new { |y| y << [class_name, true_or_false] }
+
+Benchmark.bm do |b|
+  b.report("With 1 array and 1 string value") do
+    NUMBER_OF_CALLS.times do
+      class_names(Hash[arrays.take(1) + strings.take(1)])
+    end
+  end
+
+  b.report("With 5 array and 5 string values") do
+    NUMBER_OF_CALLS.times do
+      class_names(Hash[arrays.take(5) + strings.take(5)])
+    end
+  end
+
+  b.report("With 10 array values") do
+    NUMBER_OF_CALLS.times do
+      class_names(Hash[arrays.take(10)])
+    end
+  end
+
+  b.report("With 10 string values") do
+    NUMBER_OF_CALLS.times do
+      class_names(Hash[strings.take(10)])
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: class_names
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Harris Thompson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-06 00:00:00.000000000 Z
+date: 2020-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,41 +28,46 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
-description: 
+        version: '0'
+description: 'The class_names function 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 (nil or false), that key won''t be included
+  in the output.'
 email:
 - hthompson@abodo.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gempush.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - class_names.gemspec
@@ -71,6 +76,7 @@ files:
 - lib/class_names/railtie.rb
 - lib/class_names/version.rb
 - lib/class_names/view_helper.rb
+- profiling/benchmark.rb
 homepage: https://github.com/abodo-dev/class_names
 licenses:
 - MIT
@@ -92,8 +98,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: A simple helper to conditionally join class names together.
+summary: A simple helper to conditionally join class names together
 test_files: []