enumize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6c6268b2691c51def763ed7f8261e98c410f3820609c5c5659cb5490e17bddc
+  data.tar.gz: b01b5cacf299a7fad1876cce66ebdb5eb05df437eb0448bc1a5d63b82af0c9ca
+SHA512:
+  metadata.gz: 0d23b660a5f65e1e31030bf7a69cad761458e115e832a3ab979ca2d70538df3bc8e57186fda9aea269927fe157f3667591913af72a95698121ef174e1a7a5168
+  data.tar.gz: fe206a7ac51f8e01fdccd422820278425d5fcf0973084212c6d3b0cd4e2f518886cff038f8485ccaf2a9f8d7ec148f33a6288bdfeb700e709ffa8576775b4e45

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Jason Lee
+
+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,100 @@
+# Enumize
+
+Extend ActiveRecord::Enum for add more helpful methods, from [rails/rails#36503](https://github.com/rails/rails/pull/36503).
+
+## Usage
+
+```rb
+class Book
+  enum status: %i[draft published archived]
+end
+```
+
+Now we have `status_name`, `status_color`, `status_value` and `Book.status_options` methods:
+
+- `#{attribute}_name` - return I18n name for display.
+- `#{attribute}_color` - return color for enum value from I18n file.
+- `#{attribute}_value` - return raw value for enum, Now we don't need use `Book.statuses[@book.status]`.
+- `Book.#{attribute}_options` - return a array list for select tag options, `<%= f.select :status, Book.status_options %>`.
+
+Write I18n:
+
+```yml
+en:
+  activerecord:
+    enums:
+      book:
+        status:
+          draft: Drafting
+          published: Published
+          archived: Archived
+        status_color:
+          draft: "#999999"
+          published: "green"
+          archived: "red"
+
+zh-CN:
+  activerecord:
+    enums:
+      book:
+        status:
+          draft: "草稿"
+          published: "已发布"
+          archived: "归档"
+```
+
+use the methods:
+
+```rb
+irb> @book = Book.new(status: :draft)
+irb> @book.status_value
+0
+irb> @book.status_name
+"草稿"
+irb> @book.status_color
+"#999999"
+```
+
+For `_options` methods for `select` helper:
+
+```erb
+<% form_for(@book) do |f| %>
+  <%= f.text_field :name %>
+  <%= f.select :status, Book.status_options %>
+  <%= f.submit %>
+<% end >
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enumize'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Configure the I18n fallbacks for `color` method
+
+You can write color config in `en.yml` once for all locales, so follow the I18n fallback, the others locale will
+use color value from `en`:
+
+config/application.rb
+
+```rb
+module Dummy
+  class Application < Rails::Application
+    # Add to tell I18n fallback translate to en
+    config.i18n.available_locales = ["en", "zh-CN"]
+    config.i18n.fallbacks = true
+  end
+end
+````
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Enumize"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/lib/enumize/model.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Enumize
+  module Model
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def enum(opts)
+        super(opts)
+
+        klass = self
+        singular_model_name = klass.name.singularize.underscore
+        locale_prefix = "activerecord.enums.#{singular_model_name}"
+
+        opts.each do |name, values|
+          # def status_name; I18n.t("activerecord.enums.book.status.#{status}"); end
+          detect_enum_conflict!(name, "#{name}_name")
+          define_method("#{name}_name") do
+            return "" if self.send(name).nil?
+            I18n.t("#{locale_prefix}.#{name}.#{self.send(name)}")
+          rescue I18n::MissingTranslationData
+            self[field].titleize
+          end
+
+          # def status_color; I18n.t("activerecord.enums.book.status_color.#{status}"); end
+          detect_enum_conflict!(name, "#{name}_color")
+          define_method("#{name}_color") do
+            return "black" if self.send(name).nil?
+            I18n.t("#{locale_prefix}.#{name}_color.#{self.send(name)}", raise: true)
+          rescue I18n::MissingTranslationData
+            return "black"
+          end
+
+          # def status_value; Book.statuses[self.status]; end
+          detect_enum_conflict!(name, "#{name}_value")
+          define_method("#{name}_value") do
+            return nil if self.send(name).nil?
+            klass.send(name.to_s.pluralize)[self[name]]
+          end
+
+          # Book.state_options # => [["Draft", "draft"], ["Published", "published"], ["Archived", "archived"]]
+          detect_enum_conflict!(name, "#{name}_options", true)
+          define_singleton_method("#{name}_options") do
+            self.send(name.to_s.pluralize).map do |k, _|
+              label = self.new(name => k).send("#{name}_name")
+              [label, k]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/enumize/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Enumize
+  class Railtie < ::Rails::Railtie
+    initializer "enumize.initialization" do
+      ActiveRecord::Base.send(:include, Enumize::Model)
+    end
+  end
+end

data/lib/enumize/version.rb

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

data/lib/enumize.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "enumize/version"
+require "enumize/model"
+require "enumize/railtie"
+
+module Enumize
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: enumize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: Extend ActiveRecord::Enum for add more helpful methods
+email:
+- huacnlee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/enumize.rb
+- lib/enumize/model.rb
+- lib/enumize/railtie.rb
+- lib/enumize/version.rb
+homepage: https://github.com/huacnlee/enumize
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Extend ActiveRecord::Enum for add more helpful methods.
+test_files: []