classes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7d8b60537ea194c8a560b6ed425f8624e6a11da30c5e2f0d187cede216f3d7f
+  data.tar.gz: 3254c277e5ccf9f9d84069064d385ee41fdfe5329b717bdb00a80160546c33c7
+SHA512:
+  metadata.gz: e2ee05e00318a1f17cd9da0174ea46b182259bba4111fe929a3937cee3f0044c3071de18993cdb93e3353feb6e4c374f72ac70e0a2ab6d4047ac50649314b6ac
+  data.tar.gz: 4b4bf26477a0cba3fec6cc4156c47b4ee2d7ade6f1dd776ccbd0a2bf9bd6443bab4459ea3bc59ea6bbfa8978605021f45a193d0b500a6a266d5a09b65b02f10b

data/.github/workflows/tests.yml

@@ -0,0 +1,31 @@
+name: Tests
+
+on: [push]
+
+jobs:
+  test:
+    name: Run Tests
+
+    strategy:
+      matrix:
+        ruby-version: [2.5, 2.6, 2.7]
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+
+      - name: Install gems
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+
+      - name: Run tests
+        run: |
+          bundle exec rubocop
+          bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,83 @@
+require:
+  - rubocop-performance
+
+Layout/EmptyLinesAroundAccessModifier:
+  EnforcedStyle: only_before
+
+Layout/ExtraSpacing:
+  AllowForAlignment: false
+
+Layout/IndentationConsistency:
+  EnforcedStyle: indented_internal_methods
+
+Layout/LineLength:
+  Enabled: false
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Metrics:
+  Enabled: false
+
+Style/AndOr:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/ExponentialNotation:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/IfInsideElse:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in classes.gemspec
+gemspec
+
+gem "minitest", "~> 5.0"
+gem "rake", "~> 12.0"
+gem "rubocop", "~> 0.82.0", require: false
+gem "rubocop-performance", "~> 1.5", require: false

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    classes (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    jaro_winkler (1.5.4)
+    minitest (5.14.0)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  classes!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  rubocop (~> 0.82.0)
+  rubocop-performance (~> 1.5)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright 2020 Todd Yandell
+
+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,75 @@
+# classes
+
+classes is a Ruby gem that lets you do:
+
+```erb
+<div class="<%= classes("notification", "is-danger": alert, "is-info": notice) %>">
+  <%= alert || notice %>
+</div>
+```
+
+It was inspired by the [Classnames](https://github.com/JedWatson/classnames) npm package.
+
+## Install
+
+```sh
+bundle add classes
+```
+
+### Rails
+
+Just start using `classes` in your views!
+
+### Sinatra
+
+First, `require` classes:
+
+```ruby
+require "classes"
+```
+
+For classic Sinatra apps, you're done.
+
+For modular Sinatra apps, you'll also need to include the helpers:
+
+```ruby
+class App < Sinatra::Base
+  helpers Classes::Helpers
+end
+```
+
+Now you can start using `classes` in your views!
+
+## Use
+
+The simplest use for classes is to join some strings together:
+
+```ruby
+classes("button", "is-link").to_s # => "button is-link"
+```
+
+A hash makes it easy to conditionally enable classes:
+
+```ruby
+classes("button", "is-link": true, "is-danger": false).to_s # => "button is-link"
+```
+
+classes flattens and de-dupes your classes:
+
+```ruby
+classes(["button", ["button is-link", ["is-link"]]]).to_s # => "button is-link"
+```
+
+You can combine these features as much as you like:
+
+```ruby
+classes(
+  :button, # Symbols are converted to strings.
+  "is-link is-light",
+  { "is-link": true, "is-danger": false },
+  [true && "is-link", false && "is-danger"],
+  "is-light",
+  classes("is-fullwidth": true), # You can nest Classes::ClassList instances.
+  " " # Empty or invalid classes are ignored.
+).to_s # => "button is-link is-light is-fullwidth"
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+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/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "classes"
+
+require "irb"
+IRB.start __FILE__

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/classes.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "lib/classes/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "classes"
+  spec.version = Classes::VERSION
+  spec.authors = ["Todd Yandell"]
+  spec.email = ["tyandell@gmail.com"]
+
+  spec.summary = "A helper for building CSS class names"
+  spec.description = "classes is a helper for building CSS class names in your Rails or Sinatra views. It's great for toggling individual classes or combining class names across your views and partials."
+  spec.homepage = "https://github.com/tyandell/classes"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) 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"]
+end

data/lib/classes.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "classes/version"
+require "classes/class_list"
+require "classes/helpers"
+
+if defined? Rails::Railtie
+  require "classes/railtie"
+end
+
+if defined? Sinatra
+  require "classes/sinatra"
+end

data/lib/classes/class_list.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Classes
+  class ClassList < Set
+    def self.parse(str)
+      new(str.scan(/[^\s]+/))
+    end
+
+    def add(arg)
+      return self unless arg
+
+      if arg.is_a?(Hash)
+        arg = arg.map { |k, v| v && k }
+      end
+
+      unless arg.is_a?(Enumerable)
+        arg = arg.to_s
+        return self if arg.empty?
+
+        if arg.match?(/\s/)
+          arg = self.class.parse(arg)
+        else
+          return super(arg)
+        end
+      end
+
+      merge(arg)
+    end
+
+    alias << add
+
+    def to_s
+      to_a.join(" ")
+    end
+  end
+end

data/lib/classes/helpers.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Classes
+  module Helpers
+    def classes(*args)
+      ClassList.new.merge(args)
+    end
+  end
+end

data/lib/classes/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Classes
+  class Railtie < Rails::Railtie
+    initializer "classes" do
+      ActiveSupport.on_load :action_view do
+        include Classes::Helpers
+      end
+    end
+  end
+end

data/lib/classes/sinatra.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Sinatra.helpers Classes::Helpers

data/lib/classes/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Classes
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: classes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Todd Yandell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-12 00:00:00.000000000 Z
+dependencies: []
+description: classes is a helper for building CSS class names in your Rails or Sinatra
+  views. It's great for toggling individual classes or combining class names across
+  your views and partials.
+email:
+- tyandell@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- classes.gemspec
+- lib/classes.rb
+- lib/classes/class_list.rb
+- lib/classes/helpers.rb
+- lib/classes/railtie.rb
+- lib/classes/sinatra.rb
+- lib/classes/version.rb
+homepage: https://github.com/tyandell/classes
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/tyandell/classes
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A helper for building CSS class names
+test_files: []