settings_on_rails 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b83c9ecc5fb868616dcd1708d3f5b1c6efec936
-  data.tar.gz: 8a1e64c5f65a24383fab856200b48d4acc0bdb67
+  metadata.gz: d01e255a35c506e47539e153ae23cabb903e9c52
+  data.tar.gz: 6e573d6f5554b495193174535a6998f027124eb0
 SHA512:
-  metadata.gz: 0331b4b06617abc42b1b30bb5ad595bfc3db21b121ff8b795a57e32750c6e29e6b2499a79b7dc41d3d9266befbdca74e0788e7f7eb8d0663578606f3f6e24b29
-  data.tar.gz: c91c95f9240c83ec946573063658cc3137f80b31af6444818dfa1ecdb5eb317f588363fa01589730ff369992193faf77c9e2ca3f94b33cefa45ff025f403f80d
+  metadata.gz: fc44c017dd98bcb5b3d91a7c58fd4b948efc4a2f0da732da57c610150e26d87a230277fbc7a5c7e7bf28a96cedc482249759f24e70c59ca4d2e961cf5bcd2eb9
+  data.tar.gz: 845f2459c7dd562f200fd1a3c4935d0c8980b856284ce37233bab13bbd46b5752344493f7a8590716a0cc1aa8b10b129dc5d0a072ae59026ded05a6dd1e4816f

data/README.md

@@ -4,7 +4,7 @@
 
 ## Installation
 
-Add this line to your application's Gemfile:
+If you are using [Bundler](http://bundler.io/), add this line to your application's Gemfile:
 
 ```ruby
 gem 'settings_on_rails'
@@ -14,26 +14,30 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Alternatively, install it by running:
 
     $ gem install settings_on_rails
 
 ## Getting Started
 
-Start off by adding a text field to the model which you want it to have settings
+### Add database column
+
+Start by adding a text field to the model on which you want settings:
+
 ```ruby
 rails g migration add_settings_column_to_blogs settings_column:text
-
 ```
 
-Declare in model
+### Declare in model
+
 ```ruby
 class Blog < ActiveRecord::Base
   has_settings_on :settings_column
 end
 ```
 
-Set settings
+### Set settings
+
 ```ruby
 @blog.settings.title = 'My Space'
 @blog.settings(:theme).background_color = 'blue'
@@ -41,14 +45,18 @@ Set settings
 @blog.save
 ```
 
-Get settings
+### Get settings
+
 ```ruby
-@blog.settings(:theme).background_color # returns 'blue'
+@blog.settings(:theme).background_color
+=> 'blue'
 
-@blog.settings(:post).pagination # returns nil if not set
+# returns nil if not set
+@blog.settings(:post).pagination
+=> nil
 ```
 
-## Default Values
+## Defining Default Values
 
 ```ruby
 class Blog < ActiveRecord::Base
@@ -60,50 +68,71 @@ class Blog < ActiveRecord::Base
   end
 end
 ```
+
 OR
+
 ```ruby
 class Blog < ActiveRecord::Base
   has_settings_on :column do |s|
-    s.key :theme, defaults:{ background_color: 'red', text_size: 50 }
+    s.key :theme, defaults: { background_color: 'red', text_size: 50 }
     s.attr :title, default: 'My Space'
   end
 end
 ```
 
 You can get these defaults by:
+
 ```ruby
-@blog.settings(:theme).background_color # 'red'
-@blog.settings(:theme).text_size # 50
-@blog.settings.title # 'My Space'
+@blog.settings(:theme).background_color
+=> 'red'
+
+@blog.settings(:theme).text_size
+=> 50
+
+@blog.settings.title
+=> 'My Space'
 ```
 
 ## Nested Keys
-Settings on Rails supports nested keys
+
+Settings on Rails supports nested keys by chaining calls to the `settings` method:
+
 ```ruby
 # Set
 @blog.settings(:theme).settings(:homepage).background_color = 'white'
+
 # Get
-@blog.settings(:theme).settings(:homepage).background_color # 'white'
+@blog.settings(:theme).settings(:homepage).background_color
+=> 'white'
 ```
 
-# Multiple Keys
-You can also define you nested keys in following ways, it's equal to nested keys
+## Multiple Keys
+
+You can also define multiple keys in the following way, this is equivalent to nested keys:
+
 ```ruby
 # Set
 @blog.settings(:theme, :homepage).background_color = 'white'
+
 # Get
-@blog.settings(:theme, :homepage).background_color # 'white'
+@blog.settings(:theme, :homepage).background_color
+=> 'white'
 ```
 
 
 ## Method Name Customization
-You can customize the name of the settings method
+
+You can customize the name of the `settings` method:
+
 ```ruby
 class Blog < ActiveRecord::Base
   has_settings_on :settings_column, method: :preferences
 end
+```
 
-# Then you can do
+Which allows you to do:
+
+```ruby
 @blog.preferences(:theme).background_color
 ```
 

data/lib/settings_on_rails/settings.rb

@@ -41,6 +41,10 @@ module SettingsOnRails
       current_node
     end
 
+    def inspect
+      "#<#{self.class.name}:#{self.object_id}, node: #{_current_node}>"
+    end
+
     private
 
     def _settings(*keys)

data/lib/settings_on_rails/version.rb

@@ -1,3 +1,3 @@
 module SettingsOnRails
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: settings_on_rails
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - ALLEN WANG QIANG
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-25 00:00:00.000000000 Z
+date: 2017-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -125,9 +125,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Model specific Hash Preferences/Settings for Rails.
 test_files: []
-has_rdoc: