enum_ish 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72e9f45d9096f7b3cb71b41f0eec2db69993d4b6
+  data.tar.gz: b642520f713d95c7730d9096af0b69a11a9007ac
+SHA512:
+  metadata.gz: df6c0a64caa6dfc6551c82f759dbb3697024d58d77c10ad9b552e9cf766680151db386b4fd733033e9dbda4205e7dbe5ae2e71c66ff5d17fdd382968a887b48a
+  data.tar.gz: f7ef88a3ebd6b5f13be8fb9d6ee7505d69eded7a4358279bf07196cb76238c258fd9afe7f9f99fb399f065793e50970e2266dbb8005fbd4511c5ad74cc1daa7b

data/.gitignore

@@ -0,0 +1,13 @@
+.bundle/
+.yardoc
+.project
+Gemfile.lock
+_yardoc/
+coverage/
+doc/
+pkg/
+spec/reports/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/*
+tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+gemfile:
+  - gemfiles/rails50.gemfile
+  - gemfiles/rails51.gemfile
+  - gemfiles/rails52.gemfile
+before_script:
+  - cd spec/dummy
+  - bundle exec rake db:migrate RAILS_ENV=test
+  - cd ../..
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Yoshikazu Kaneta
+
+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,159 @@
+# EnumIsh
+
+A ruby and rails extension to generate enum-like methods.
+
+## Dependencies
+
+* ruby 2.3+
+* activesupport 5.0+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enum_ish'
+```
+
+Then execute:
+
+    $ bundle
+
+## Usage
+
+Extend your class using EnumIsh and define an enum-like field:
+
+```ruby
+class User
+  extend EnumIsh
+  attr_accessor :status                    # status is a string field
+  enum_ish :status, ['enable', 'disable']  # status has 'enable' or 'disable'
+end
+```
+
+Then define i18n translations (example below shows japanese translations):
+
+```yaml
+ja:
+  enum_ish:
+    user:
+      enable: 有効
+      disable: 無効
+```
+
+Enum-like methods are generated as follows:
+
+```ruby
+user = User.new
+user.status = 'enable'
+user.status_text     #=> "有効"
+User.status_options  #=> [["有効", "enable"], ["無効", "disable"]]
+```
+
+### Additional translations
+
+Define additional translations:
+
+```yaml
+ja:
+  enum_ish:
+    user:
+      status:
+        enable: 有効
+        disable: 無効
+      status/short:
+        enable: 有
+        disable: 無
+```
+
+```ruby
+user = User.new
+user.status = 'enable'
+user.status_text(format: :short)     #=> "有"
+User.status_options(format: :short)  #=> [["有", "enable"], ["無", "disable"]]
+```
+
+### Default value
+
+Set default value:
+
+```ruby
+class User
+  extend EnumIsh
+  attr_accessor :status
+  enum_ish :status, ['enable', 'disable'], default: 'enable'
+end
+
+user = User.new
+user.status  #=> "enable"
+```
+
+### Predicates
+
+Generate predicate methods:
+
+```ruby
+class User
+  extend EnumIsh
+  attr_accessor :status
+  enum_ish :status, ['enable', 'disable'], predicate: true
+end
+
+user = User.new
+user.status = 'enable'
+user.status_enable?   #=> true
+user.status_disable?  #=> false
+```
+
+### Accessor
+
+Generate getter and setter for aliased symbols instead of raw values:
+
+```ruby
+class User
+  extend EnumIsh
+  attr_accessor :status
+  enum_ish :status, { _enable: 'enable', _disable: 'disable' }, accessor: true
+end
+
+user = User.new
+user.status = :_enable
+user.status              #=> :_enable
+user.status_raw          #=> "enable"
+```
+
+### Scope (for ActiveRecord)
+
+Generate scope:
+
+```ruby
+class User < ActiveRecord::Base
+  extend EnumIsh
+  enum_ish :status, ['enable', 'disable'], scope: true
+end
+
+User.with_status(:enable)  #=> SELECT "users".* FROM "users" WHERE "users"."status" = "enable"
+```
+
+### Validation (for ActiveRecord)
+
+Generate validation:
+
+```ruby
+class User < ActiveRecord::Base
+  extend EnumIsh
+  enum_ish :status, ['enable', 'disable'], validate: true
+end
+
+user = User.new
+user.status = 'INVALID'
+user.valid?  #=> false
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/kanety/enum_ish.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/enum_ish.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enum_ish/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "enum_ish"
+  spec.version       = EnumIsh::VERSION
+  spec.authors       = ["Yoshikazu Kaneta"]
+  spec.email         = ["kaneta@sitebridge.co.jp"]
+  spec.summary       = %q{A ruby and rails extension to generate enum-like methods}
+  spec.description   = %q{A ruby and rails extension to generate enum-like methods}
+  spec.homepage      = "https://github.com/kanety/enum_ish"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 5.0"
+
+  spec.add_development_dependency "rails", ">= 5.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "pry-rails"
+  spec.add_development_dependency "pry-byebug"
+end

data/gemfiles/rails50.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 5.0.0"
+
+gemspec path: "../"

data/gemfiles/rails51.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 5.1.0"
+
+gemspec path: "../"

data/gemfiles/rails52.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 5.2.0.rc1"
+
+gemspec path: "../"

data/lib/enum_ish.rb

@@ -0,0 +1,18 @@
+require 'active_support'
+require 'enum_ish/version'
+require 'enum_ish/builder'
+require 'enum_ish/builder/active_record' if defined?(ActiveRecord::Base)
+
+module EnumIsh
+  def enum_ish(attr, enum, config = {})
+    [:text, :options].each do |key|
+      config[key] = true unless config.key?(key)
+    end
+
+    if defined?(ActiveRecord::Base) && self.ancestors.include?(ActiveRecord::Base)
+      Builder::ActiveRecord.new(self).build(attr, enum, config)
+    else
+      Builder.new(self).build(attr, enum, config)
+    end
+  end
+end

data/lib/enum_ish/builder.rb

@@ -0,0 +1,119 @@
+module EnumIsh
+  class Builder
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def build(attr, enum, config = {})
+      if enum.is_a?(Array)
+        enum = enum.map { |v|
+          k = v.to_s.to_sym
+          v = v.to_s if v.is_a?(Symbol)
+          [k, v]
+        }.to_h
+      end
+
+      [:text, :options, :predicate, :accessor, :validate, :scope].each do |key|
+        if config[key]
+          send("define_#{key}", attr, enum, config)
+        end
+      end
+
+      if config.key?(:default)
+        define_default_value(attr, enum, config)
+      end
+    end
+
+    private
+
+    def define_text(attr, enum, config)
+      method = "#{attr}_text"
+
+      @klass.class_eval do
+        define_method method do |options = {}|
+          value = public_send(attr)
+          dic = EnumIsh::Dictionary.new(self.class).load(attr, enum, config, options)
+          dic[value] || value
+        end
+      end        
+    end
+
+    def define_options(attr, enum, config)
+      method = "#{attr}_options"
+
+      @klass.class_eval do
+        define_singleton_method method do |options = {}|
+          dic = EnumIsh::Dictionary.new(self).load(attr, enum, config, options)
+          dic.invert.to_a
+        end
+      end
+    end
+
+    def define_predicate(attr, enum, config)
+      enum.each do |key, value|
+        method = "#{attr}_#{key}?".tr('.', '_')
+        @klass.class_eval do
+          define_method method do
+            public_send(attr) == value
+          end
+        end
+      end
+    end
+
+    def define_default_value(attr, enum, config)
+      mod = Module.new
+      mod.module_eval do
+        define_method :initialize do |*args|
+          public_send("#{attr}=", config[:default]) if respond_to?(attr) && public_send(attr).nil?
+          super(*args)
+        end
+      end
+      @klass.prepend mod
+    end
+
+    def define_accessor(attr, enum, config)
+      method = "#{attr}_raw"
+
+      @klass.class_eval do
+        define_method method do
+          instance_variable_get("@#{attr}")
+        end
+        define_method "#{attr}" do
+          enum.invert[instance_variable_get("@#{attr}")]
+        end
+        define_method "#{attr}=" do |value|
+          instance_variable_set("@#{attr}", enum[value])
+        end
+      end
+    end
+
+    def define_validate(attr, enum, config)
+      @klass.class_eval do
+        validates attr, inclusion: { in: enum.values }, allow_nil: true
+      end
+    end
+  end
+
+  class Dictionary
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def load(attr, enum, config, options)
+      dict = load_i18n(attr, enum, options)
+
+      translated = enum.map { |k, v| dict[k] ? [k, dict[k]] : [k, v.to_s] }.to_h
+      translated = translated.map { |k, v| [enum[k], v] }.to_h unless config[:accessor]
+      translated
+    end
+
+    private
+
+    def load_i18n(attr, enum, options)
+      attr_key = [attr, options.delete(:format)].compact.join('/')
+      i18n_options = options.merge(default: [:"enum_ish.defaults.#{attr_key}", enum.invert])
+      dict = I18n.t("enum_ish.#{@klass.name.underscore}.#{attr_key}", i18n_options)
+      dict.map { |k, v| [k.to_s.to_sym, v.to_s] }.to_h
+    end
+  end
+end

data/lib/enum_ish/builder/active_record.rb

@@ -0,0 +1,44 @@
+module EnumIsh
+  class Builder
+    class ActiveRecord < Builder
+      private
+
+      def define_default_value(attr, enum, config)
+        method = "_enum_ish_init_#{attr}".to_sym
+
+        @klass.class_eval do
+          after_initialize method
+          define_method method do
+            public_send("#{attr}=", config[:default]) if respond_to?(attr) && public_send(attr).nil?
+          end
+        end
+      end
+
+      def define_accessor(attr, enum, config)
+        method = "#{attr}_raw"
+
+        @klass.class_eval do
+          define_method method do
+            read_attribute(attr)
+          end
+          define_method "#{attr}" do
+            enum.invert[read_attribute(attr)]
+          end
+          define_method "#{attr}=" do |value|
+            write_attribute(attr, enum[value])
+          end
+        end
+      end
+
+      def define_scope(attr, enum, config)
+        method = "with_#{attr}"
+
+        @klass.class_eval do
+          scope method, ->(value) {
+            where(attr => value)
+          }
+        end
+      end
+    end
+  end
+end

data/lib/enum_ish/version.rb

@@ -0,0 +1,3 @@
+module EnumIsh
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: enum_ish
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yoshikazu Kaneta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+- !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'
+- !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: simplecov
+  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-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'
+description: A ruby and rails extension to generate enum-like methods
+email:
+- kaneta@sitebridge.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- enum_ish.gemspec
+- gemfiles/rails50.gemfile
+- gemfiles/rails51.gemfile
+- gemfiles/rails52.gemfile
+- lib/enum_ish.rb
+- lib/enum_ish/builder.rb
+- lib/enum_ish/builder/active_record.rb
+- lib/enum_ish/version.rb
+homepage: https://github.com/kanety/enum_ish
+licenses: []
+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.5.2.2
+signing_key: 
+specification_version: 4
+summary: A ruby and rails extension to generate enum-like methods
+test_files: []