enum_help 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66948f4f12b02670eca05becf8556dc1c4b765f7
-  data.tar.gz: f2a5ffef59a3f708dddaa285df1e4cd1cb17a8d1
+  metadata.gz: d9bab58fee36f103d6dac37d93f64f56ceaa870c
+  data.tar.gz: e6b064455eb7a58d63f568d03000d3cb458c5ec2
 SHA512:
-  metadata.gz: d276091006d58d131fe38c1467a5fdf595592814cbfeb6a519fedd4200f9ee16d106de237f5cbb7916e0aa5bd6126e8cc62b197dd28a3b4880f9519fa53115a4
-  data.tar.gz: c999f3fa91dd5c9485c6c7069cf5872b4fc762e78f8e7956a9681d5e46ea2a1206a2555d079e03cc57038ab8c2826c145e5a9606d3eeaedc5b282244527bb074
+  metadata.gz: 090068e7311f52bb00f9b2c0c6391144d50fefdf669aa38583b609d7c3da3de422da4e00429307463a4c45539c0518f135898f6dc2df21256c75e9c1782eba9b
+  data.tar.gz: 4079525deb12d50abce3806e0e5e14031ba0649c47a0c91cafd8a6828ef51914a100b6232e6d73c7c0d24513502a1f3e743c454fc873ebcf1614ad63a4156b21

data/README.md

@@ -26,72 +26,96 @@ Or install it yourself as:
 ## Usage
 
 
-required Rails 4.1.x
+Required Rails 4.1.x
 
 In model file:
 
-    class Order < ActiveRecord::Base
-      enum status: { "nopayment" => 0, "finished" => 1, "failed" => 2, "destroyed" => 3 }
+```ruby
+class Order < ActiveRecord::Base
+  enum status: { "nopayment" => 0, "finished" => 1, "failed" => 2, "destroyed" => 3 }
       
-      def self.restricted_statuses
-        statuses.except :failed, :destroyed
-      end
-    end
+  def self.restricted_statuses
+    statuses.except :failed, :destroyed
+  end
+end
+```
 
 You can call:
 
-    order = Order.first
-    order.update_attribute :status, 0
-    order.status
-    # > nopayment
-    order.status_i18n # if you have an i18n file defined as following, it will return "未支付".
-    # > 未支付
+```ruby
+order = Order.first
+order.update_attribute :status, 0
+order.status
+# > nopayment
+order.status_i18n # if you have an i18n file defined as following, it will return "未支付".
+# > 未支付
+```
 
-In _form.html.erb using simple_form:
+You can also fetch the translated enum collection, if you need to:
 
-    <%= f.input :status %>
+```ruby
+Order.statuses_i18n
+```
+
+In `_form.html.erb` using `simple_form`:
+
+```erb
+<%= f.input :status %>
+```
 
 This will generate select field with translations automaticlly.
 
 And if you want to generate select except some values, then you can pass a collection option.
 
-    <%= f.input :status Order.restricted_statuses %>
+```erb
+<%= f.input :status, Order.restricted_statuses %>
+```
 
+Other arguments for `simple_form` are supported perfectly.
+
+e.g.
 
+```erb
+<%= f.input :status, prompt: 'Please select a stauts' %>
 
-Other arguments for simple_form are supported perfectly.
+<%= f.input :status, as: :string %>
+```
+
+From version 0.0.10, enum_help can automaticlly generate radio buttons with i18n labels.
 
 e.g.
+```erb
+<%= f.input :status, as: :radio_buttons %>
+```
+
 
-    <%= f.input :status, prompt: 'Please select a stauts' %>
-    
-    <%= f.input :status, as: :string %>
 
 
 I18n local file example:
 
-    # config/locals/model/order.zh-cn.yml
-    zh-cn:
-      enums:
-        order:
-          status:
-            finished: 完成
-            nopayment: 未支付
-            failed: 失败
-            destroyed: 已删除
+```yaml
+# config/locals/model/order.zh-cn.yml
+zh-cn:
+  enums:
+    order:
+      status:
+        finished: 完成
+        nopayment: 未支付
+        failed: 失败
+        destroyed: 已删除
+```
 
 
 ## Notice
-If you want to use enum feature,
-field of your table can't be named with reference.
+If you want to use enum feature, field of your table can't be named with `reference`.
 When it is named with 'reference' and define enum in model file, there will be raise an error as below:
 
     NoMethodError: super: no superclass method `enum' for...
 
 
 ## Thanks
-* [mrhead](https://github.com/mrhead)
-* [Jin Lee](https://github.com/neojin)
+
+Thanks for all the [contributors](https://github.com/zmbacker/enum_help/graphs/contributors).
 
 ## Contributing
 

data/lib/enum_help/i18n.rb

@@ -1,25 +1,16 @@
 module EnumHelp
+
   module I18n
 
     # overwrite the enum method
     def enum( definitions )
-      klass = self
       super( definitions )
-      definitions.each do |name, values|
-        # def status_i18n() statuses.key self[:status] end
-        i18n_method_name = "#{name}_i18n".to_sym
-        define_method(i18n_method_name) do
-          enum_value = self.send(name)
-          if enum_value
-            ::I18n.t("enums.#{klass.to_s.underscore}.#{name}.#{enum_value}", default: enum_value)
-          else
-            nil
-          end
-        end
+      definitions.each do |name, _|
+        Helper.define_attr_i18n_method(self, name)
+        Helper.define_collection_i18n_method(self, name)
       end
     end
 
-
     def self.extended(receiver)
       # receiver.class_eval do
       #   # alias_method_chain :enum, :enum_help
@@ -27,5 +18,44 @@ module EnumHelp
     end
 
   end
-end
 
+  module Helper
+
+    def self.define_attr_i18n_method(klass, attr_name)
+      attr_i18n_method_name = "#{attr_name}_i18n"
+
+      klass.class_eval <<-METHOD, __FILE__, __LINE__
+      def #{attr_i18n_method_name}
+        enum_label = self.send(:#{attr_name})
+        if enum_label
+          ::EnumHelp::Helper.translate_enum_label(self.class, :#{attr_name}, enum_label)
+        else
+          nil
+        end
+      end
+      METHOD
+    end
+
+    def self.define_collection_i18n_method(klass, attr_name)
+      collection_method_name = "#{attr_name.to_s.pluralize}"
+      collection_i18n_method_name = "#{collection_method_name}_i18n"
+
+      klass.instance_eval <<-METHOD, __FILE__, __LINE__
+      def #{collection_i18n_method_name}(*args)
+        options = args.extract_options!
+        collection = args[0] || send(:#{collection_method_name})
+        collection.except! options[:except] if options[:except]
+
+        collection.map do |label, value|
+          [::EnumHelp::Helper.translate_enum_label(self, :#{attr_name}, label), value]
+        end.to_h
+      end
+      METHOD
+    end
+
+    def self.translate_enum_label(klass, attr_name, enum_label)
+      ::I18n.t("enums.#{klass.to_s.underscore}.#{attr_name}.#{enum_label}", default: enum_label)
+    end
+
+  end
+end

data/lib/enum_help/simple_form.rb

@@ -6,13 +6,22 @@ module EnumHelp
 
       def default_input_type_with_enum(*args, &block)
         att_name = (args.first || @attribute_name).to_s
+        options = args.last
+        return :enum_radio_buttons if options.is_a?(Hash) && options[:as] == :radio_buttons &&
+                                      is_enum_attributes?( att_name )
 
-        return :enum if (args.last.is_a?(Hash) ? args.last[:as] : @options[:as]).nil? &&
-                        object.class.respond_to?(att_name.pluralize) && att_name.pluralize != "references"
+        return :enum if (options.is_a?(Hash) ? options[:as] : @options[:as]).nil? &&
+                        is_enum_attributes?( att_name )
 
         default_input_type_without_enum(*args, &block)
       end
 
+
+      def is_enum_attributes?( attribute_name )
+        object.class.respond_to?(attribute_name.pluralize) && attribute_name.pluralize != "references"
+      end
+
+
     end
 
     module InputExtension
@@ -22,7 +31,7 @@ module EnumHelp
         enum = input_options[:collection] || @builder.options[:collection]
         raise "Attribute '#{attribute_name}' has no enum class" unless enum ||= object.class.send(attribute_name.to_s.pluralize)
 
-        collect = enum.collect{|k,v| [::I18n.t("enums.#{object.class.to_s.underscore}.#{attribute_name}.#{k}", default: k),k] }
+        collect = object.class.send("#{attribute_name.to_s.pluralize}_i18n", enum.to_h).to_a
         # collect.unshift [args.last[:prompt],''] if args.last.is_a?(Hash) && args.last[:prompt]
 
         if respond_to?(:input_options)
@@ -45,10 +54,19 @@ class EnumHelp::SimpleForm::EnumInput < ::SimpleForm::Inputs::CollectionSelectIn
   end
 end
 
+
+class EnumHelp::SimpleForm::EnumRadioButtons < ::SimpleForm::Inputs::CollectionRadioButtonsInput
+  include EnumHelp::SimpleForm::InputExtension
+
+end
+
+
 SimpleForm::FormBuilder.class_eval do
   include EnumHelp::SimpleForm::BuilderExtension
 
-  map_type :enum, :to => EnumHelp::SimpleForm::EnumInput
+  map_type :enum,               :to => EnumHelp::SimpleForm::EnumInput
+  map_type :enum_radio_buttons, :to => EnumHelp::SimpleForm::EnumRadioButtons
+  alias_method :collection_enum_radio_buttons, :collection_radio_buttons
   alias_method :collection_enum, :collection_select
   alias_method_chain :default_input_type, :enum
 end

data/lib/enum_help/version.rb

@@ -1,3 +1,3 @@
 module EnumHelp
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enum_help
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Lester Zhao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-25 00:00:00.000000000 Z
+date: 2014-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler