easy_settings 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e7a4cd755414c8b9ac73537415a9354c216cfbe
-  data.tar.gz: bb8c676c3225d497595cc0524566c268e97fb444
+  metadata.gz: b576c4cc8f7df5949f577776925dd2cf736f25b9
+  data.tar.gz: f752df3e59269a8fc30ab5461452d236ecc0537a
 SHA512:
-  metadata.gz: 4e84cede6e0deb01912732e031d493cba0fb2f33cbfc45d77ee9a36496e20e969fe5d6172780d760599b04e9b47bc77606310b2488fa724a9ede9b904121646f
-  data.tar.gz: 5c84841fb7e8c092a80ebaac569fbc7c3079e9d960b03a77773941b8baeefee7e6dcdccc47c4e4920a013250d11101270ff57b59f8af2273504227467d03982d
+  metadata.gz: a07f2b0934754767fea381bc86e9ee33e75be14395cf87ed1fa98bde1931f0cbfa3000ea3910f0c19512e3f66737537cd7c152251efaf804580b9278f8b27b4d
+  data.tar.gz: aef00e04a6612a1055ef9c494fe1b49a04a1c24a2a90288f183271545c3277c29ccf404d69ea659a0cd8373ea89939d61b0f2b939a7ed1cea14aefa50a954052

data/README.md

@@ -1,6 +1,5 @@
 # EasySettings
-
-TODO: Write a gem description
+EasySettings is a simple manager of setting constants.
 
 ## Installation
 
@@ -19,8 +18,169 @@ Or install it yourself as:
     $ gem install easy_settings
 
 ## Usage
+EasySettings can load YAML file and understand ERB format.
+
+### Basic usage
+Most simple usage is to put your settings file `settings.yml` to your application's root directory.
+
+`settings.yml` or `config/settings.yml`:
+
+```yaml
+app_name: EasySettingsSample
+users:
+  nownabe:
+    gender: male
+    like: ["Angra", "Helloween", "SEX MACHINEGUNS", "μ's"]
+timestamp: <%= Time.now.to_s %>
+```
+
+And your application can use EasySettings:
+
+```ruby
+require "easy_settings"
+
+EasySettings.app_name    #=> "EasySettingsSample"
+EasySettings["app_name"] #=> "EasySettingsSample"
+EasySettings[:app_name]  #=> "EasySettingsSample"
+
+EasySettings.users
+#=> {"nownabe"=>{"gender"=>"male", "like"=>["Angra", "Helloween", "SEX MACHINEGUNS", "μ's"]}}
+EasySettings.users[:nownabe][:gender]
+#=> "male"
+EasySettings.users.nownabe.like
+#=> ["Angra", "Helloween", "SEX MACHINEGUNS", "μ's"]
+
+EasySettings.timestamp
+#=> 2015-03-07 00:11:28 +0900
+```
+
+You can set value to any key.
+
+```ruby
+EasySettings.app_name = "MyApp" #=> "MyApp"
+EasySettings["app_name"]        #=> "MyApp"
+EasySettings[:app_name]         #=> "MyApp"
+
+EasySettings["app_name"] = "MyApp2" #=> "MyApp2"
+EasySettings.app_name               #=> "MyApp2"
+EasySettings[:app_name]             #=> "MyApp2"
+```
+
+If you want to use other settings file, you can use any other file with `EasySettings.source_file =`.
+
+```ruby
+EasySettings.source_file = Rails.root.join("config/application.yml").to_s
+```
+
+### Namespace
+You can use namespace.
+
+Settings YAML file:
+
+```yaml
+defaults: &defaults
+  app_name: NamespaceSample
+  endpoint: http://backend-dev/api/v1
+
+development:
+  <<: *defaults
+  apikey: DEVFOOBAR123
+  secret: DEVBAZQUX789
+
+production:
+  <<: *defaults
+  endpoint: http://backend/api/v1
+  apikey: PRDFOOBAR123
+  secret: PRDBAZQUX789
+```
+
+Using EasySettings with `namespace =`:
+
+```ruby
+Rails.env
+#=> "production"
+
+EasySettings.namespace = Rails.env
+#=> "production"
+
+EasySettings.app_name
+#=> "NamespaceSample"
 
-TODO: Write usage instructions here
+EasySettings.endpoint
+#=> "http://backend/api/v1"
+```
+
+### Default value
+You can set default value.
+Default value will be set with key when EasySettings doesn't have key.
+
+```ruby
+EasySettings.has_key?(:foo)
+#=> false
+
+EasySettings.foo
+#=> nil
+
+EasySettings.foo("bar")
+#=> "bar"
+
+EasySettings.foo
+#=> "bar"
+
+EasySettings.has_key?(:foo)
+#=> true
+
+EasySettings.foo("baz")
+#=> "bar"
+```
+
+Using nil option, you can set nil:
+
+```ruby
+EasySettings.app_name(nil)
+#=> nil
+EasySettings.has_key?(:app_name)
+#=> false
+
+EasySettings.app_name(nil, nil: true)
+#=> nil
+EasySettings.has_key?(:app_name)
+#=> true
+```
+
+And EasySettings can treat nested hash:
+
+```ruby
+EasySettings.users({}).nownabe = {gender: :male}
+#=> {:gender=>:male}
+EasySettings.to_h
+#=> {"users"=>{"nownabe"=>{"gender"=>:male}}}
+```
+
+### Reset EasySettings
+```ruby
+EasySettings.source_file = "new_settings.yml"
+EasySettings.reload!
+
+EasySettings.source_hash = {}
+EasySettings.reload!
+```
+
+### Alias
+```ruby
+Config = EasySettings
+Config.app_name = "AliasSample"
+```
+
+Or using class that inherit EasySettings:
+
+```ruby
+class Config < EasySettings
+  self.namespace = Rails.env
+end
+
+Config.endpoint
+```
 
 ## Contributing
 

data/lib/easy_settings.rb

@@ -28,6 +28,14 @@ class EasySettings < Hashie::Mash
       load!
     end
 
+    def [](key)
+      instance[key]
+    end
+
+    def []=(key, val)
+      instance[key] = val
+    end
+
     private
 
     def _source

data/lib/easy_settings_version.rb

@@ -1,3 +1,3 @@
 module EasySettingsVersion
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_settings
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - nownabe