activeadmin_settings_cached 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a234d2b3c9d9c19458b00ee6ebe8af9a7e3fc059
-  data.tar.gz: 5e36ecdc24654ac093f47d535d4ca41ff7a32bbc
+  metadata.gz: 93deb43bc251b8519edab152fd3384bd5919cda5
+  data.tar.gz: c1961c0ad4cc34c1b1dc0d8b01fea2fbf6e7463a
 SHA512:
-  metadata.gz: eb3960656d5aea1fa39585d632242bc3e333b7735c64eb88324ec5cd4941632218a5e25abf7f0da75dc060bcc9105a7e2ff4a032cef7bef4384712fad3dc4b17
-  data.tar.gz: c5be99fd6db507ab68462b8056f9c379566ec5e6406e87961b0b2782ba91fe90c0c1f46e91fcecb424cc6b51d08664c30aa53e2126705b7f37001b9f82ad976c
+  metadata.gz: d2a7704a63453e64e58ea07d7abe6eb3c03755e7f648837ac8266d2587b6483af551799a4c32629b1d1ca71b2c316b2119017f2f19f5dc1b63a090ed0be391c6
+  data.tar.gz: e74d53cdb81779620046399605d29b1e4ad27e82d21b232f47b2f6db60b6eb6e78d43fc38f7cf8234268366f9dfd4ea01bf9d3da326e2c0108dd3fd0cb929e96

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/activeadmin_settings_cached.svg)](http://badge.fury.io/rb/activeadmin_settings_cached)
 
-Gem for Rails provides ui interface for rails-settings-cached gem in Active Admin 
+Provides a nice UI interface for [rails-settings-cached](https://github.com/huacnlee/rails-settings-cached) gem in [Active Admin](http://activeadmin.info/).
 
 ## Installation
 
@@ -16,19 +16,19 @@ And then execute:
 
     $ bundle
 
-Create you settings model:
+Create your settings model:
 
     $ rails g settings Settings
     $ bundle exec rake db:migrate
 
-Add route in config/routes.rb
+Add a route in config/routes.rb
 
 ``` ruby
 ActiveAdmin.routes(self)
-mount ActiveadminSettingsCached::Engine => '/admin' 
+mount ActiveadminSettingsCached::Engine => '/admin'
 ```
 
-And configure you default values in model Settings like this:
+And configure your default values in your Settings model:
 
 ``` ruby
 class Settings < RailsSettings::CachedSettings
@@ -36,9 +36,9 @@ class Settings < RailsSettings::CachedSettings
 end
 ```
 
-And in your appication admin avaliable new page with this settings
+In your application's admin interface, there will now be a new page with this setting
 
-# Localization
+## Localization
 You can localize settings keys in local file
 
 ``` yml
@@ -48,12 +48,29 @@ en:
       my_awesome_settings:
         name: 'My Awesome Lolaized Setting'
 ```
+## Model name
 
-If you settings model named not Settings, you can define model name in
-`config/initializers/active_admin_settings_cached.rb`
+By default the name of the mode is `Settings`. If you want to use a different name for the model, you can specify your that in `config/initializers/active_admin_settings_cached.rb`:
 
 ``` ruby
-ActiveadminSettingsCached.settings_class = 'AdvancedSetting'
+ActiveadminSettingsCached.configure do |config|
+  config.model_name = 'AdvancedSetting'
+end
+```
+
+## Display options
+
+If you need define display options for settings fields, eg textarea, url or :timestamp and etc., you can set `display` option in initializer.
+
+
+``` ruby
+ActiveadminSettingsCached.configure do |config|
+  condig.display = {
+    my_awesome_setting_name: :text,
+    my_awesome_setting_name_2: :timestamp,
+    my_awesome_setting_name_3: :select
+  }
+end
 ```
 
-For how use Settings in you application see documentation fo rails-settings-cached gem https://github.com/huacnlee/rails-settings-cached
+Available options see [here](https://github.com/justinfrench/formtastic#the-available-inputs)

data/activeadmin_settings_cached.gemspec

@@ -3,24 +3,24 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'activeadmin_settings_cached/version'
 
-Gem::Specification.new do |spec|
-  spec.name          = "activeadmin_settings_cached"
-  spec.version       = ActiveadminSettingsCached::VERSION
-  spec.authors       = ["Semyon Pupkov"]
-  spec.email         = ["semen.pupkov@gmail.com"]
-  spec.summary       = %q{UI interface for rails-settings-cached in active admin}
-  spec.description   = ""
-  spec.homepage      = ""
-  spec.license       = "MIT"
+Gem::Specification.new do |s|
+  s.name          = "activeadmin_settings_cached"
+  s.version       = ActiveadminSettingsCached::VERSION
+  s.authors       = ["Semyon Pupkov"]
+  s.email         = ["semen.pupkov@gmail.com"]
+  s.summary       = "UI interface for rails-settings-cached in active admin"
+  s.description   = "UI interface for rails-settings-cached in active admin"
+  s.homepage      = "https://github.com/artofhuman/activeadmin_settings_cached"
+  s.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
 
-  spec.add_dependency 'activeadmin'
-  spec.add_dependency 'rails-settings-cached'
+  s.add_dependency 'activeadmin'
+  s.add_dependency 'rails-settings-cached'
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rake"
 end

data/app/admin/settings.rb

@@ -8,9 +8,6 @@ ActiveAdmin.register_page "Settings" do
   end
 
   controller do
-    def settings_list
-      settings = ActiveadminSettingsCached.settings_klass
-      settings.defaults.merge!(settings.get_all)
-    end
+    helper :settings
   end
 end

data/app/controllers/activeadmin_settings_cached/settings_controller.rb

@@ -1,10 +1,8 @@
 module ActiveadminSettingsCached
   class SettingsController < ApplicationController
     def update
-      settings = ActiveadminSettingsCached.settings_klass
-
       settings_params.each_pair do |name, value|
-        settings[name] = value
+        settings_model[name] = value
       end
 
       flash[:success] = t('.success'.freeze)
@@ -14,9 +12,11 @@ module ActiveadminSettingsCached
     private
 
     def settings_params
-      settings_keys = ActiveadminSettingsCached.settings_klass.defaults.keys
+      params.require(:settings).permit(settings_model.defaults.keys)
+    end
 
-      params.require(:settings).permit(settings_keys)
+    def settings_model
+      ActiveadminSettingsCached.config.model_name
     end
   end
 end

data/app/helpers/settings_helper.rb

@@ -0,0 +1,20 @@
+module SettingsHelper
+  def settings_field_options(settings_name)
+    default_value = ActiveadminSettingsCached.defaults[settings_name]
+    value = ActiveadminSettingsCached.settings[settings_name]
+
+    input_opts = if default_value.is_a?(Array)
+                  {
+                    collection: default_value,
+                    selected: value,
+                  }
+                else
+                  {
+                    input_html: {value: value, placeholder: default_value},
+                  }
+                end
+
+    {as: ActiveadminSettingsCached.config.display[settings_name], label: false}
+      .merge!(input_opts)
+  end
+end

data/app/views/admin/settings/_index.html.erb

@@ -8,12 +8,12 @@
         </tr>
       </thead>
       <tbody>
-        <% controller.settings_list.each_pair do |name,  value| %>
+        <% ActiveadminSettingsCached.settings.each_pair do |name, value| %>
           <tr class="odd">
             <td><strong><%= f.label t("settings.attributes.#{name}.name", default: name) %></strong></td>
             <td>
               <div class='form'>
-                <ol><%= f.input name, label: false, input_html: { value: value } %></ol>
+                <ol><%= f.input name, settings_field_options(name) %></ol>
               </div>
             </td>
           </tr>

data/lib/activeadmin_settings_cached/version.rb

@@ -1,3 +1,3 @@
 module ActiveadminSettingsCached
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

data/lib/activeadmin_settings_cached.rb

@@ -1,12 +1,43 @@
 require "activeadmin_settings_cached/engine"
 
 module ActiveadminSettingsCached
-  mattr_accessor :settings_class
-  self.settings_class = "Settings"
+  class Configuration
+    attr_accessor :model_name, :display
+
+    def model_name
+      (@model_name ||= 'Settings').constantize
+    end
+
+    def display
+      (@display ||= {}).with_indifferent_access
+    end
+  end
 
   class << self
-    def settings_klass
-      settings_class.constantize
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+
+    def settings
+      config.model_name.public_send(meth)
+    end
+
+    def defaults
+      config.model_name.defaults
+    end
+
+    private
+
+    def meth
+      if Rails.version >= '4.1.0'
+        :get_all
+      else
+        :all
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activeadmin_settings_cached
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Semyon Pupkov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-31 00:00:00.000000000 Z
+date: 2015-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
@@ -41,32 +41,32 @@ dependencies:
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
-description: ''
+description: UI interface for rails-settings-cached in active admin
 email:
 - semen.pupkov@gmail.com
 executables: []
@@ -81,6 +81,7 @@ files:
 - activeadmin_settings_cached.gemspec
 - app/admin/settings.rb
 - app/controllers/activeadmin_settings_cached/settings_controller.rb
+- app/helpers/settings_helper.rb
 - app/views/admin/settings/_index.html.erb
 - config/locales/en.yml
 - config/locales/ru.yml
@@ -88,7 +89,7 @@ files:
 - lib/activeadmin_settings_cached.rb
 - lib/activeadmin_settings_cached/engine.rb
 - lib/activeadmin_settings_cached/version.rb
-homepage: ''
+homepage: https://github.com/artofhuman/activeadmin_settings_cached
 licenses:
 - MIT
 metadata: {}