internal_name_helper 0.1.0 → 0.2.5

data/README.md

@@ -1,9 +1,13 @@
 Internal Name Helper for Active Model
 ====================
 
-Pre-Load all records from database, then generate helper methods.
+Pre-Load all records from database, then generate some helper methods.
 
-For example
+Since all records will be pre-loaded, and stored in the Rails instance. This is not suitable for large models. 
+
+## Scenarios:
+
+### Plan
 
 There are 3 plans in the Plan model
 
@@ -12,19 +16,43 @@ lite
 standard
 pro
 
+Include the module in Model part
+
+```ruby
+	gem 'internal_name_helper'
+```
+
+```ruby
+	class Plan < ActiveRecord::Base  
+	  include InternalNameHelper::Methods
+	end
+```
+
 The following methods will be generated
 
+Class Methods
+
+```ruby
+	Plan.lite
+	Plan.standard
+	Plan.pro
+```
+
+Instance Methods
+
 ```ruby
-Plan.lite
-Plan.standard
-Plan.pro
+	plan.is_lite?
+	plan.is_not_lite?
+	plan.is_standard?
+	plan.is_not_standard?
+	plan.is_pro?
+	plan.is_not_pro?
 ```
 
+Examples
+
 ```ruby
-plan.is_lite?
-plan.is_not_lite?
-plan.is_standard?
-plan.is_not_standard?
-plan.is_pro?
-plan.is_not_pro?
-```
+	@current_plan = Plan.lite
+	if @current_plan.is_lite?
+	end
+```

data/lib/internal_name_helper/version.rb

@@ -1,3 +1,3 @@
 module InternalNameHelper
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.5'.freeze
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: internal_name_helper
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 29
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 0
-  version: 0.1.0
+  - 2
+  - 5
+  version: 0.2.5
 platform: ruby
 authors: 
 - Elan Meng
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-06-09 00:00:00 +08:00
+date: 2014-06-10 00:00:00 +08:00
 default_executable: 
 dependencies: []