vinber 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5846099a1282c804d8caee37689c761e2c46e8f4
-  data.tar.gz: b06ec6b47bb81c6e8349064513aae54b9e8ef2aa
+  metadata.gz: 0e998cd2a9472e745967acb3344182b7a1af4df1
+  data.tar.gz: e208761a1a37fa1a0ec676b565b249c2ae112bfb
 SHA512:
-  metadata.gz: 40dca19b242327e0c29915d62a528a1983f5b632d7ae6667d359809045402eb30f80351ac2549608fd6d8b69bbe7eb0e36c1a0a72abeb1c4ef7d81a05d6ab0de
-  data.tar.gz: 4a73b9e8f2b025307a0a351817a6c9206b0757eb1872218270e618b71b0d21cee1af459f00f59767795e4270c0a50c7f499fe1d5f534b88b3497484529a19ac8
+  metadata.gz: 25c68c7efa5884c70c3e0b0350162cda2b7ffdd4e5dfb3a23f44565cec4c24b0b3cfeef74d65a95e39acde14948649faeabd23abba2803a56c5bbb1a058ab3bd
+  data.tar.gz: de6429a9e832dde6d1aa4386dd63643cdc5dfd40c7bdb111bef7c0a7011397c2508f6edc19bd980c71093bc636351f41e8db7b30770f0b22cfca71e206366e07

data/.gitignore

@@ -1,3 +1,4 @@
+# Default
 /.bundle/
 /.yardoc
 /Gemfile.lock
@@ -10,3 +11,39 @@
 
 # rspec failure tracking
 .rspec_status
+
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## RUBYMINE
+.idea
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+.ruby-version
+gemfiles/*.gemfile.lock
+Gemfile.lock
+/tmp
+/.bundle
+/gemfiles/.bundle
+
+## PROJECT::RVM
+.rvmrc
+
+# PROJECT::RBENV
+.ruby-gemset
+*.gem

data/README.md

@@ -1,90 +1,120 @@
 ## Vinber ##
 
-Vinber works for Rails, provides other way enumeration style which without force format output and force method definations.
+ Enumeration with I18N solution for Rails, which without force output formatting and force method defining.
 
-__NOTE__: Vinber current version *require* Ruby v1.9.0 or later and just tested on Rails 4.x for now .
+__NOTE__: vinber works fine with Rails 4.x or later.
 
 
 ### Installation ###
-    # Installing as Ruby gem
+    # Manually from RubyGems.org
     $ gem install vinber
 
-    # Or in gemfile
+    # Or Gemfile if you are using Bundler
     $ gem vinber
 
 ### Usage ###
+To use vinber is as simple as defining table attribute in its Model, and using Hash or Array are supported:
 
-#### vinber
-You will be able to use `vinber` in any model which inherit `ActiveRecord::Base`.
 ```ruby
-vinber attribute: {} # hash
-vinber attribute: [] # array
-```
+# app/models/user.rb
+# User(id: integer, name: string, :status: integer, language: string)
+class User < ActiveRecord::Base
 
-### vinber_list
-`vinber_list` return a nested Array, it besides the attribute I18n value and vinber key.
-```ruby
-vinber_list class_object, attribute
+  vinber :status => {:registered => 1, :active => 2, :locked => 3}
+
+end
 ```
 
-### vinber_value
-`vinber_value` return the I18n value of specific attribute.
+This provides you with a couple of public methods for class  `User` and its instances:
 
 ```ruby
-vinber_value instance_object, attribute
+User.defined_vinbers             # => {'status' => {:registered => 1, :active => 2, :locked => 3}}
+User.vinber_defined?             # => true
+User.vinber_defined?(:status)    # => true
+User.vinber_defined?(:language)  # => false
+User.vinbers.status              # => {:registered => 1, :active => 2, :locked => 3}
+User.vinber_list(:status)        # => [['Registered', 1], ['Active', 2], ['Locked', 3]]
+
+# We assume there are a lot of records in User Table
+User.first.status                # => 2
+User.first.vinber_value(:status) # => 'Active'
+
+# if the attribute not defined by vinber, vinber_value return the real value
+User.vinber_defined?(:id)        # => false
+User.first.vinber_value(:id)     # => 1
 ```
 
-### Examples ###
-Step 1, you need define your vinbers in your model.
+### i18n ###
+You will be able to use i18n of vinber when you defines attribute with `Hash`, as default, vinber always try to find the translation from current local yaml file. if not found, vinber will fetch the attribute and return the right hash key string.
 
 ```ruby
-# app/models/your_models.rb
-class YourModel < ActiveRecord::Base
-  ...
-
-  vinber :status => {:submited => 1, :processing => 2, :completed => 3}
-
-  ...
-end
+User.first.status                # => 2
+User.first.vinber_value(:status) # => 'Active'
+User.vinber_list(:status)        # => [['Registered', 1], ['Active', 2], ['Locked', 3]]
 ```
+Setting locale like below format:
 
-Step 2, set your locale for I18n.
 ```yaml
 # config/locales/zh.yml or en.yml(any yml your want)
 zh:
   vinber:
-    YourModel:
-      status_submited: 提交
-      status_processing: 进行中
-      status_completed: 完成
+    User:
+      status_registered: 已注册
+      status_active: 已激活
+      status_locked: 锁定中
 
 ```
 
-Step 3, invoking in view !! We assume you has YourModel and it contains records, the status of first record is `2`.
+If current locale is `zh`, you will see:
 
-```haml
-# app/views/your_modles/index.haml
-- obj = YourModel.first
-%p= vinber_value(obj, :status)
+```ruby
+User.first.vinber_value(:status) # => '已激活'
+User.vinber_list(:status)        # => [['已注册', 1], ['已激活', 2], ['锁定中', 3]]
+```
+
+Alternative, if you don't want it to be translated, just use `:t => false`, this will be useful when you writing api program, you don't want different locals to change the result.
+
+```ruby
+User.first.vinber_value(:status, :t => false) # => 'active'
+User.vinber_list(:status, :t => false)        # => [['registered', 1], ['active', 2], ['locked', 3]]
+```
 
-# => <p>进行中</p>
+Sometimes, the array by  `vinber_list` is not what you expect, you could use block to customize:
 
-= form_tag({}) do
-  = select_tag "status", options_for_select(vinber_list YourModel, :status)
+```ruby
+User.vinber_list(:status) do |key, value|
+  "#{key}: #{value}"
+end
+# => ["已注册: 1", "已激活: 2", "锁定中: 3"]
+
+User.vinber_list(:status, :t => false) do |key|
+  key.upcase
+end
+# => ["REGISTERED", "ACTIVE", "LOCKED"]
+```
+
+### Validates ###
+
+For database safety, vinber provides validates to check security of value when saving, but it's disabled by default, you can enable with option `:validates => true`.
+
+```ruby
+class User < ActiveRecord::Base
+
+  vinber :status => {:registered => 1, :active => 2, :locked => 3}, :validates => true
+
+end
 
-# =>  <form accept-charset="UTF-8" method="post">
-# =>    <select name="status" id="status">
-# =>      <option value="1">提交</option>
-# =>      <option value="2">进行中</option>
-# =>      <option value="3">完成</option>
-# =>    </select>
-# =>  </form>
+user = User.new(
+  :name => 'Charles',
+  :status => 4    # status is 4, expected in [1, 2, 3]
+)
+user.save            # false
+user.errors.messages # {:status => ["is not included in the list"]}
 ```
 
 ### TODO ###
-- Write more clear document
-- Add soft warning when error
-- more functions
+- Improve compatibility
+- Make it easy to ActiveRecord Query
 
 ### License ###
 Released under the [MIT](http://opensource.org/licenses/MIT) license. See LICENSE file for details.

data/lib/vinber/current_vinbers.rb

@@ -0,0 +1,19 @@
+module Vinber
+  class CurrentVinbers
+
+    attr :vinbers
+
+    def initialize(vinbers = {})
+      @vinbers = vinbers.with_indifferent_access
+    end
+
+    def method_missing(name, *args)
+      if vinbers.has_key? name
+        vinbers[name]
+      else
+        super
+      end
+    end
+
+  end
+end

data/lib/vinber/translate.rb

@@ -0,0 +1,25 @@
+module Vinber
+  class Translate
+
+    VALUE_LABLE = "vinber.%{klass}.%{attribute}_%{key}"
+
+    def initialize(klass, attribute, attribute_vinber_key)
+      @label = {
+        :klass     => (klass.is_a?(Class) ? klass.name : klass),
+        :attribute => attribute,
+        :key       => attribute_vinber_key
+      }
+    end
+
+    def label
+      @label ||= %()
+    end
+
+    def text
+      @text ||= I18n.t (VALUE_LABLE % label), default: label[:key].to_s.humanize
+    end
+
+    alias_method :to_s, :text
+
+  end
+end

data/lib/vinber/version.rb

@@ -1,3 +1,3 @@
 module Vinber
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/vinber/vinber_list.rb

@@ -0,0 +1,21 @@
+module Vinber
+  module List
+
+    def vinber_list(attribute, options = {}, &block)
+      klass = self
+      raise VinberUndefined, "Vinber was undefined in #{klass.name}" unless klass.vinber_defined?
+
+      need_tanslate = options.fetch(:t){true}
+      if klass.vinber_defined? attribute
+        attribute_vinber = klass.defined_vinbers[attribute.to_s]
+        return attribute_vinber unless attribute_vinber.is_a?(Hash)
+
+        attribute_vinber.map do |key, value|
+          key = Vinber::Translate.new(klass, attribute, key).to_s if need_tanslate
+          block_given?? block.call(key, value) : [key, value]
+        end
+      end.to_a
+    end
+
+  end
+end

data/lib/vinber/vinber_value.rb

@@ -0,0 +1,22 @@
+module Vinber
+  module Value
+
+    def vinber_value(attribute, options = {})
+      obj   = self
+      klass = obj.class
+      val   = obj.send(attribute.to_sym)
+      api   = options.fetch(:t) {false}
+
+      if klass.vinber_defined?(attribute) &&
+        (attribute_vinber = klass.defined_vinbers[attribute.to_s]).is_a?(Hash)
+
+        attribute_vinber_key = attribute_vinber.key val
+        api ? attribute_vinber_key.to_s : Vinber::Translate.new(klass, attribute, attribute_vinber_key).to_s
+      else
+        val
+      end
+    end
+
+  end
+end
+

data/lib/vinber.rb

@@ -18,7 +18,10 @@ module Vinber
   end
 
   def vinber(definitions)
+    need_validates = definitions.delete(:validates)
     definitions.each do |name, values|
+      detect_vinber_conflict! name
+      validates_from_vinber name, values if need_validates
       defined_vinbers[name.to_s] = case
       when values.is_a?(Hash)
         values.with_indifferent_access
@@ -37,16 +40,38 @@ module Vinber
   def vinber_defined?(attr_key = nil)
     attr_key ? defined_vinbers.has_key?(attr_key.to_s) : defined_vinbers.present?
   end
-end
 
-# Extend/Include to Rails
-ActiveRecord::Base.extend Vinber
-ActiveRecord::Base.extend Vinber::Value
-ActiveRecord::Base.send(:include, Vinber::Value)
+  private
+
+  VINBER_CONFLICT_MESSAGE = \
+    "You tried to define a vinber named %{name} in %{klass}, but it's already defined by %{source}."
+
+  def detect_vinber_conflict!(name)
+    if vinber_defined?(name)
+      raise_vinber_conflict_error(name, 'Vinber')
+    elsif defined_enums[name.to_s]
+      raise_vinber_conflict_error(name, 'Enum')
+    end
+  end
 
-ApplicationHelper.extend Vinber::Value
-ApplicationHelper.send(:include, Vinber::Value)
-ApplicationHelper.send(:include, Vinber::List)
+  def validates_from_vinber(name, val)
+    val = val.is_a?(Hash) ? val.values : Array.wrap(val).flatten
+    class_eval { validates name.to_sym, inclusion: {in: val} }
+  end
 
-ApplicationController.extend Vinber::Value
-ApplicationController.send(:include, Vinber::Value)
+  def raise_vinber_conflict_error(name, source)
+    raise ArgumentError, VINBER_CONFLICT_MESSAGE % {
+      name: name,
+      klass: self.name,
+      source: source
+    }
+  end
+
+end
+
+# Extend/Include to ActiveRecord::Base
+ActiveRecord::Base.class_eval do
+  extend  Vinber
+  extend  Vinber::List
+  include Vinber::Value
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vinber
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - cenxky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-30 00:00:00.000000000 Z
+date: 2017-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,7 +55,11 @@ files:
 - bin/console
 - bin/setup
 - lib/vinber.rb
+- lib/vinber/current_vinbers.rb
+- lib/vinber/translate.rb
 - lib/vinber/version.rb
+- lib/vinber/vinber_list.rb
+- lib/vinber/vinber_value.rb
 - vinber.gemspec
 homepage: https://github.com/cenxky/vinber
 licenses: