settingson 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53c3e07180aa0dfaf6b850053ae23ff9b1b76b80
-  data.tar.gz: 95ad343d4cbac37232f35e9120ea7f69863298a9
+  metadata.gz: 0752abcd5f9b547030d3b6dba21da1eb6b089154
+  data.tar.gz: c0225eecd8deae31e29b2c53998b82f4fb55618e
 SHA512:
-  metadata.gz: b362eb805962ce0d746cb2b9f6bc7933c3b521833333b2cc2b953a30f303e36a6d25d3d53d6db2040feb1fd8237d56f90c594a583c990a96b934e9ab8c627b65
-  data.tar.gz: d8b4ab009d2eb3035a82ba3f39ade3420430d5250239981d90e247c8ef6ec8a7cca4d11fdb7d4abdc7c3203b91777ed5f74a85ebe9d05cd0c022c580bdd799c3
+  metadata.gz: 847c4da786c0c542715c77496a21a5deafe565a134d1473859b4d3a7b421763f6e2ee02dee4f85535d86840feee4f098c93d781b52c43f7b63a86250e7ed99a4
+  data.tar.gz: b7627dac777a30f9c2be130596b6a3b7825e2a915ca78c89dbf253cfbc66abb8172a7bde7d2101e533cf4ef671d0ad2193a32bd42614d51ff12151324da9f1db

data/README.md

@@ -2,49 +2,78 @@
 
 # Settingson
 
-Settings management for Ruby on Rails 4 applications (ActiveRecord) 
+Simple settings management for applications (Ruby on Rails 4 with ActiveRecord)
 
+## Example
+
+shell commands:
+```console
+rails g settingson Settings
+rake db:migrate
+```
+
+code:
 ```ruby
 Settings.server.host = '127.0.0.1'
 Settings.server.port = '8888'
 
-Settings.server.host # => '127.0.0.1'
-Settings.server.port # => '8888'
+Settings.server.host        # => '127.0.0.1'
+Settings.server.port        # => '8888'
 
 Settings.server.smtp.host = '127.0.0.1'
 Settings.server.smtp.port = 25
 
-Settings.server.smtp.host # => "127.0.0.1"
-Settings.server.smtp.port # => 25
+Settings.server.smtp.host   # => "127.0.0.1"
+Settings.server.smtp.port   # => 25
 
-# With hash
-Settings.rules = { '1st RULE' => 'You do not talk about FIGHT CLUB.' }
-Settings.rules['1st RULE'] #  => "You do not talk about FIGHT CLUB."
+Settings.from_hash({hello: :world})
+Settings.hello              # => :world
 
-# With array
-Settings.array = [ 1, 2, 3, 4, 5 ]
-Settings.array # => [1, 2, 3, 4, 5]
+Settings.not_found          # => ""
+Settings.not_found.nil?     # => true
+Settings.not_found.empty?   # => true
+Settings.not_found.blank?   # => true
+Settings.not_found.present? # => false
 
-# Array of hashes
-Settings.array_of.hashes = [ { hello: :world}, {'glad' => :to}, {see: 'you'} ]
-Settings.array_of.hashes # => [{:hello=>:world}, {"glad"=>:to}, {:see=>"you"}]
-
-# Boolean
-Settings.item # => false
-Settings.item = :hello
-Settings.item # => true
-
-# ActiveRecord
-Settings.item! #  => <Settings id: 1, key: "item", value: :hello, created_at: "...", updated_at: "...">
+# but
+Settings.not_found.class    # => Settings(id: integer, key: string, value: text, created_at: datetime, updated_at: datetime)
 ```
 
 ### Using with [Simple Form](https://github.com/plataformatec/simple_form) and [Haml](https://github.com/haml/haml)
 in view:
 ```ruby
-= simple_form_for(Settings, url: settings_path) do |f|
+= simple_form_for( Settings, url: settings_path, method: :patch ) do |f|
   = f.error_notification
-  = f.input :'host.port'
-  = f.button :submit
+  = f.input :'server.smtp.host', label: 'SMTP Host', as: :string, placeholder: 'mail.google.com'
+  = f.input :'server.smtp.port', label: 'SMTP Port', as: :string, placeholder: '25'
+  = f.button :submit, t('update', default: 'Update settings')
+```
+
+in controller:
+```ruby
+class SettingsController < ApplicationController
+  def update
+    if Settings.from_hash(params[:settings])
+      flash[:notice] = t('settings_updated', default: 'Settings updated successfully')
+    else
+      flash[:alert]  = t('settings_not_updated', default: 'Settings not updated')
+    end
+    render :edit
+  end
+end
+```
+
+## The initial values
+in config/initializers/settingson.rb
+```ruby
+Rails.application.config.after_initialize do
+  begin
+    Settings.server.smtp.host? || Settings.server.smtp.host = 'host'
+    Settings.server.smtp.port? || Settings.server.smtp.port = '25'
+  rescue
+    Rails.logger.warn('Something goes wrong')
+  end
+end
 ```
 
 ## Installation
@@ -72,44 +101,13 @@ Or install it yourself as:
 ```console
 rails g settingson MODEL
 ```
-Replace MODEL by the class name used for the applications settings, it's frequently `Settings` but could also be `Configuration`. This will create a model (if one does not exist) and configure it with default options. 
-
-Next, you'll usually run 
-```console
-rake db:migrate
-``` 
-as the generator will have created a migration file (if your ORM supports them).
-
-## Example
+Replace MODEL by the class name used for the applications settings, it's frequently `Settings` but it may also be `Configuration` or something else. This will create a model (if one does not exist) and configure it with default options.
 
+Next, you'll usually run
 ```console
-rails g settingson Settings
 rake db:migrate
 ```
-
-In rails console:
-```ruby
-2.1.1 :006 > Settings.hello.hello3.hello2
-  Settings Load (0.2ms)  SELECT "settings".* FROM "settings" WHERE "settings"."name" = 'hello' LIMIT 1
-  Settings Load (0.2ms)  SELECT "settings".* FROM "settings" WHERE "settings"."name" = 'hello.hello3' LIMIT 1
-  Settings Load (0.1ms)  SELECT "settings".* FROM "settings" WHERE "settings"."name" = 'hello.hello3.hello2' LIMIT 1
- => #<Settingson::Store:0x000001016aee68 @klass=Settings(id: integer, name: string, value: text, created_at: datetime, updated_at: datetime), @name="hello.hello3.hello2", @value=#<Settingson::Store:0x000001016aee68 ...>>
- 
-2.1.1 :007 > Settings.hello.hello3.hello2 = 1
-  Settings Load (0.2ms)  SELECT "settings".* FROM "settings" WHERE "settings"."name" = 'hello' LIMIT 1
-  Settings Load (0.2ms)  SELECT "settings".* FROM "settings" WHERE "settings"."name" = 'hello.hello3' LIMIT 1
-  Settings Load (0.1ms)  SELECT "settings".* FROM "settings" WHERE "settings"."name" = 'hello.hello3.hello2' LIMIT 1
-   (0.1ms)  begin transaction
-  SQL (5.2ms)  INSERT INTO "settings" ("created_at", "name", "updated_at", "value") VALUES (?, ?, ?, ?)  [["created_at", Sat, 03 May 2014 09:45:25 UTC +00:00], ["name", "hello.hello3.hello2"], ["updated_at", Sat, 03 May 2014 09:45:25 UTC +00:00], ["value", "--- 1\n...\n"]]
-   (2.4ms)  commit transaction
- => 1
- 
-2.1.1 :008 > Settings.hello.hello3.hello2
-  Settings Load (0.3ms)  SELECT "settings".* FROM "settings" WHERE "settings"."name" = 'hello' LIMIT 1
-  Settings Load (0.2ms)  SELECT "settings".* FROM "settings" WHERE "settings"."name" = 'hello.hello3' LIMIT 1
-  Settings Load (0.1ms)  SELECT "settings".* FROM "settings" WHERE "settings"."name" = 'hello.hello3.hello2' LIMIT 1
- => 1
- ```
+as the generator will have created a migration file (if your ORM supports them).
 
 ## Contributing
 

data/app/models/concerns/settingson/base.rb

@@ -8,13 +8,23 @@ module Settingson::Base
   end
 
   def to_s
-    self.new_record? ? '' : self.value.to_s
+    self.new_record? ? '' : super
+  end
+
+  def inspect
+    self.new_record? ? '""' : super
   end
 
   def to_i
-    self.new_record? ? 0 : self.value.to_i
+    self.new_record? ? 0 : super
+  end
+
+  def nil?
+    self.new_record? ? true : super
   end
 
+  alias empty? nil?
+
   def method_missing(symbol, *args)
     super
   rescue NoMethodError
@@ -22,7 +32,11 @@ module Settingson::Base
     case symbol.to_s
     when /(.+)=/  # setter
 
-      @settingson = "#{@settingson}.#{$1}"
+      if not defined?(@settingson) or @settingson.blank?
+        @settingson = $1
+      else
+        @settingson += ".#{$1}"
+      end
 
       if record = self.class.find_by(key: @settingson) and args.first.nil?
         record.destroy
@@ -31,6 +45,7 @@ module Settingson::Base
       else
         self.class.create(key: @settingson, value: args.first)
       end
+
     when /(.+)\?$/  # returns boolean
       @settingson = "#{@settingson}.#{$1}"
       self.class.find_by(key: @settingson).present?
@@ -56,6 +71,15 @@ module Settingson::Base
 
   module ClassMethods
 
+    def from_hash(attributes)
+      case attributes
+      when Hash
+        attributes.map{|k,v| find_or_create_by(key: k).update!(value: v)}
+      else
+        false
+      end
+    end
+
     def method_missing(symbol, *args)
       super
     rescue NoMethodError
@@ -72,8 +96,7 @@ module Settingson::Base
         else
           create(key: @settingson, value: args.first, settingson: @settingson)
         end
-
-      when /(.+)\?$/  #
+      when /(.+)\?$/  # returns boolean
         find_by(key: $1).present?
       when /(.+)\!$/  # returns self or nil
         find_by(key: $1)
@@ -91,4 +114,4 @@ module Settingson::Base
 
   end
 
-end
+end

data/lib/settingson/version.rb

@@ -1,3 +1,3 @@
 module Settingson
-  VERSION = "1.3.1"
+  VERSION = "1.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: settingson
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - dan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails