string_enums 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19bba143fb76cf81a8efe6f7a9fffadedb814798
+  data.tar.gz: c673dfb78350e22e222029da336434685144b10f
+SHA512:
+  metadata.gz: c12780e700a5f18a28a30f152aa533d3ba76f6d55d3902d2ed8d1b7d81ebaaf60004d48259c7316514eb850a4cc53c45e41a654cb4d278227b2d6a4eb183d58c
+  data.tar.gz: d1e0f022318fd7a6d83610e2e8b5631c81a77fdb5651407d3814ba8a52471554583e304481c58873129c5b2f038ea94437b345741b931eb9fdd6a954b0f92df4

data/CHANGELOG.md

@@ -0,0 +1 @@
+TODO

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2017, Bed Bath & Beyond
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,42 @@
+# string_enums
+
+StringEnums is a concern that makes it easy to work with enums. Include the module, then invoke
+the class method string_enum with the attribute name followed by the list of valid values. This will
+add checks, writers, and constants for each value.
+
+
+## Usage
+```
+class Person < ActiveRecord::Base
+  include StringEnums
+  string_enum status: %w(living dead reviving zombie permanently_dead)
+end
+```
+
+```
+class FilesystemObject < ActiveRecord::Base
+  include StringEnums
+  string_enum kind: ['file', 'folder', 'symbolic link']
+end
+```
+
+
+## Example
+A class declares `string_enum status: ['pending', 'in progress', 'completed']`, which adds
+the following...
+
+... checks:
+* `pending?`
+* `in_progress?`
+* `completed?`
+
+... and writers:
+* `mark_pending`
+* `mark_in_progress`
+* `mark_completed`
+
+... and constants:
+* `STATUS_PENDING`
+* `STATUS_IN_PROGRESS`
+* `STATUS_COMPLETED`
+

data/lib/string_enums.rb

@@ -0,0 +1,62 @@
+# = String Enums
+#
+# StringEnum is a concern that makes it easy to work with enums. Include the module, then invoke
+# the class method string_enum with the attribute name followed by the list of valid values. This will
+# add checks, writers, and constants for each value.
+#
+# == Example
+# A class declares <tt>string_enum status: ['pending', 'in progress', 'completed']</tt>, which adds
+# the following...
+# ... checks:
+# * <tt>pending?</tt>
+# * <tt>in_progress?</tt>
+# * <tt>completed?</tt>
+#
+# ... and writers:
+# * <tt>mark_pending</tt>
+# * <tt>mark_in_progress</tt>
+# * <tt>mark_completed</tt>
+#
+# ... and constants:
+# * <tt>STATUS_PENDING</tt>
+# * <tt>STATUS_IN_PROGRESS</tt>
+# * <tt>STATUS_COMPLETED</tt>
+#
+# Note that the string values with spaces are snake cased to provide method and constant names.
+module StringEnums
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    # rubocop:disable Metrics/MethodLength
+    def string_enum(pairs)
+      pairs.each do |name, values|
+        values.each do |value|
+          snake_case_value = value.tr(' ', '_')
+
+          class_eval <<-RUBY
+            const_set("#{name.upcase}_#{snake_case_value.upcase}", '#{value}')
+
+            def #{snake_case_value}?
+              string_enum_check_value?(:#{name}, '#{value}')
+            end
+
+            def mark_#{snake_case_value}
+              string_enum_write_value(:#{name}, '#{value}')
+            end
+          RUBY
+        end
+      end
+    end
+  end
+
+  private
+
+  def string_enum_check_value?(status_attribute_name, value)
+    status = send(status_attribute_name)
+    status.present? && status == value
+  end
+
+  def string_enum_write_value(status_attribute_name, value)
+    send("#{status_attribute_name}=", value)
+  end
+end

data/spec/string_enums_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+class TesterWithStatus
+  include StringEnums
+  string_enum the_status: ['pending', 'in progress', 'completed']
+  attr_accessor :the_status
+end
+
+RSpec.describe StringEnums do
+  let(:tester) { TesterWithStatus.new }
+
+  %w(pending in\ progress completed).each do |status_value|
+    context "for status #{status_value}" do
+      let(:snake_status) { status_value.tr(' ', '_') }
+      it 'has checker' do
+        expect(tester).to respond_to("#{snake_status}?")
+      end
+
+      it 'has constant' do
+        constant_name = "THE_STATUS_#{snake_status.upcase}"
+        expect(tester.class.const_get(constant_name)).to eq status_value
+      end
+
+      it 'has writer' do
+        expect(tester).to respond_to("mark_#{snake_status}")
+      end
+
+      it 'checker returns true' do
+        tester.the_status = status_value
+        expect(tester.public_send("#{snake_status}?")).to be_truthy
+      end
+
+      it 'checker returns false' do
+        tester.the_status = 'another value'
+        expect(tester.public_send("#{snake_status}?")).to be_falsey
+      end
+
+      it 'writes status' do
+        tester.the_status = 'another value'
+        tester.public_send("mark_#{snake_status}")
+        expect(tester.the_status).to eq status_value
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: string_enums
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Todd Kummer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: |-
+  == StringEnum is a concern that makes it easy to work with enums. Include the module, then invoke
+  the class method string_enum with the attribute name followed by the list of valid values. This will
+  add checks, writers, and constants for each value.
+email: engrteam@onekingslane.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/string_enums.rb
+- spec/string_enums_spec.rb
+homepage: http://github.com/okl/string_enums
+licenses:
+- BSD 3-clause
+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: 1.2.0
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Allows using string enums in ActiveRecord models instead of integers
+test_files: []