exnum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94835057ae6ed47472c1db7f5ac350751d613270
+  data.tar.gz: c66802026aa68c3490b843594bc176cb0bd1968c
+SHA512:
+  metadata.gz: 29e6109316bf870ceb49401060f23404c9f74fe7a48b119796b1f53d6940eb15bf289253e0c324d812e7700fbb374414b742429be7ceee1a30216b8358a499fd
+  data.tar.gz: 85a8dd2163bd8109d6a0c4a74ed33a775dca2f4f4ed72c468bca0ccb2f4a789e12b469c424e69508023d526b195bad37ae62936a28b79d065aaee3c432f92992

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5
+script: CODECLIMATE_REPO_TOKEN=9eff3c4d9a268cc72972edde460103ef26b162565dafa64ef5b86649fd43427f bundle exec rake

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at mohri1219@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kta-M
+
+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,106 @@
+# Exnum
+
+[![Gem Version](https://badge.fury.io/rb/exnum.svg)](https://badge.fury.io/rb/exnum)
+[![Build Status](https://travis-ci.org/Kta-M/exnum.svg?branch=master)](https://travis-ci.org/Kta-M/exnum)
+[![Code Climate](https://codeclimate.com/github/Kta-M/exnum/badges/gpa.svg)](https://codeclimate.com/github/Kta-M/exnum)
+[![Test Coverage](https://codeclimate.com/github/Kta-M/exnum/badges/coverage.svg)](https://codeclimate.com/github/Kta-M/exnum/coverage)
+
+Exnum is enum extention for Rails.
+This gem extends enum about i18n and associated parameters.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'exnum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exnum
+
+## Usage
+
+ActiveRecord:
+```
+class User < ActiveRecord::Base
+  # the value of the key "val" defines enum values
+  # and the others defines associated parameters
+  exnum role: {
+    guest:   {val: 10, label: :red },
+    general: {val: 20, label: :green, permission: false },
+    admin:   {val: 30, label: :blue,  permission: true},
+  }
+end
+
+```
+
+I18n:
+```
+ja:
+  activerecord:
+    enum:
+      user:        # model name
+        role:      # field name
+          guest:   ゲスト
+          general: 一般ユーザー
+          admin:   管理者
+
+```
+
+Then you can use i18n extention
+```
+User.roles_i18n
+# => {"guest" => "ゲスト", "general" => "一般ユーザー", "admin" => "管理者"}
+
+user = User.new(role: :guest)
+user.role_i18n
+# => "ゲスト"
+```
+
+and assosiated parameter extention.
+```
+User.role_labels
+# => {"guest" => :red, "general" => :green, "admin" => :blue}
+User.role_permissions
+# => {"guest" => nil, "general" => false, "admin" => true}
+
+user = User.new(role: :general)
+user.role_label
+# => :green
+user.role_permission
+# => false
+```
+
+And of cause, you can use methods provided by `enum`.
+
+`exnum` can also use as well as `enum`.
+Then you can use extention only about i18n.
+```
+class User < ActiveRecord::Base
+  exnum role: [:guest, :general, :admin]
+end
+```
+```
+class User < ActiveRecord::Base
+  exnum role: {guest: 10, general: 20, admin: 30}
+end
+```
+
+## Contributing
+
+1. Fork it!
+1. Create your feature branch (git checkout -b my-new-feature)
+1. Commit your changes (git commit -am 'Add some feature')
+1. Push to the branch (git push origin my-new-feature)
+1. Create a new Pull Request
+
+## 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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "exnum"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exnum.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exnum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "exnum"
+  spec.version       = Exnum::VERSION
+  spec.authors       = ["Kta-M"]
+  spec.email         = ["mohri1219@gmail.com"]
+
+  spec.summary       = %q{Enum extention for Rails}
+  spec.description   = %q{Exnum is enum extention for Rails. This gem extends enum about i18n and associated parameters.}
+  spec.homepage      = "https://github.com/Kta-M/exnum"
+  spec.license       = "MIT"
+
+  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 'activerecord'
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sqlite3", "~> 1.0"
+  spec.add_development_dependency "pry-rails"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

data/lib/exnum/active_record/exnum.rb

@@ -0,0 +1,120 @@
+module ActiveRecord
+  module Exnum
+    def self.prepended(base)
+      base.singleton_class.class_eval { self.prepend(ClassMethods) }
+    end
+    module ClassMethods
+      def extended(base)
+        base.class_attribute(:defined_params, instance_writer: false)
+        base.defined_params = {}
+        super(base)
+      end
+    end
+
+    def inherited(base)
+      base.defined_params = defined_params.deep_dup
+      super
+    end
+
+    #--------------------------------------------------------------------------
+
+    def exnum(definitions)
+      divided_definitions = definitions.inject({enums: {}, params: {}}) do |ret, (name, values)|
+        if !self.column_names.include?(name.to_s) || !values.kind_of?(Hash)
+          ret[:enums][name]  = values
+        else
+          ret[:enums][name]  = extract_enums(name, values)
+          ret[:params][name] = extract_params(name, values)
+        end
+        ret
+      end
+
+      enum(divided_definitions[:enums])
+      enum_i18n(divided_definitions[:enums])
+      enum_param(divided_definitions[:params])
+    end
+
+    #--------------------------------------------------------------------------
+
+    private
+    def extract_enums(_name, values)
+      values.inject({}) do |ret, (field, value)|
+        ret[field.to_sym] = (value.kind_of?(Hash) ? value[:val] : value)
+        ret
+      end
+    end
+
+    def extract_params(_name, values)
+      values.inject({}) do |ret, (field, value)|
+        if value.kind_of?(Hash)
+          ret[field.to_sym] = value.reject{|k, _| k == :val}
+        end
+        ret
+      end
+    end
+
+    def enum_i18n(definitions)
+      klass = self
+      definitions.delete(:_prefix)
+      definitions.delete(:_suffix)
+
+      definitions.each do |name, values|
+
+        # define class method which returns i18n string of each satus
+        method_name = "#{name.to_s.pluralize}_i18n"
+        detect_enum_conflict!(name, method_name, true)
+        klass.singleton_class.send(:define_method, method_name) do
+          i18n_hash = ActiveSupport::HashWithIndifferentAccess.new
+          values.inject(i18n_hash) do |ret, (enum_name, _value)|
+            ret[enum_name] = i18n_string(klass, name, enum_name)
+            ret
+          end
+        end
+
+        # define instance method which returns current i18n string of the instance
+        method_name = "#{name}_i18n"
+        detect_enum_conflict!(name, method_name, false)
+        klass.send(:define_method, method_name) do
+          status = self.send(name)
+          status.nil? ? nil : klass.send(:i18n_string, klass, name, status)
+        end
+      end
+    end
+
+    def i18n_string(klass, name, enum_name)
+      I18n.t("#{klass.i18n_scope}.enum.#{klass.model_name.i18n_key}.#{name}.#{enum_name}")
+    end
+
+    def enum_param(definitions)
+      klass = self
+      klass.defined_params = definitions
+
+      definitions.each do |name, values|
+        param_names = values.values.map(&:keys).flatten.uniq
+        param_names.each do |param_name|
+
+          # define class methods which returns the parameter's values of each status
+          method_name = "#{name}_#{param_name.to_s.pluralize}"
+          detect_enum_conflict!(name, method_name, true)
+          klass.singleton_class.send(:define_method, method_name) do
+            param_hash = ActiveSupport::HashWithIndifferentAccess.new
+            values.inject(param_hash) do |ret, (enum_name, params)|
+              ret[enum_name] = params[param_name]
+              ret
+            end
+          end
+
+          # define instance methods which returns the parameter's current value of the instance
+          method_name = "#{name}_#{param_name}"
+          detect_enum_conflict!(name, method_name, false)
+          define_method(method_name) do
+            status = self.send(name)
+            return if status.nil?
+            defined_params[name][status.to_sym][param_name]
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/exnum/version.rb

@@ -0,0 +1,3 @@
+module Exnum
+  VERSION = "0.1.0"
+end

data/lib/exnum.rb

@@ -0,0 +1,5 @@
+require 'active_record' unless defined? ActiveRecord
+require "exnum/version"
+require "exnum/active_record/exnum"
+
+ActiveRecord::Enum.prepend(ActiveRecord::Exnum)

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: exnum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kta-M
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.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: codeclimate-test-reporter
+  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: Exnum is enum extention for Rails. This gem extends enum about i18n and
+  associated parameters.
+email:
+- mohri1219@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exnum.gemspec
+- lib/exnum.rb
+- lib/exnum/active_record/exnum.rb
+- lib/exnum/version.rb
+homepage: https://github.com/Kta-M/exnum
+licenses:
+- MIT
+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.1
+signing_key: 
+specification_version: 4
+summary: Enum extention for Rails
+test_files: []