settingify 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d60134a199d33fe55c04d10031746387559577d2
-  data.tar.gz: c0fccd95aa5921ad05350e1f53427131eec5f17a
+  metadata.gz: 94d92a3f44c051e69e85ffaec7d69028ec7ed1f8
+  data.tar.gz: 0ef9c8d16d8c5fc549fc30ac0867db0b4f6f3339
 SHA512:
-  metadata.gz: 17d4af4daf3e64d3e3f0dd0c0cc5abfe9c095213b3aade574fa968805d3c23ce3b0ab1cdd32d6b7133b6e1ad6bdd5dfbe76e3ac13c76b4a77ab779dbbc89ee26
-  data.tar.gz: 10fd93b652403f8a60ffafa6b14d856369928696fbddad7f7e3177dcd47320b39d39ab224ea420e04f9ef095875791e4761fe89116d5b5ec9204554a770d381f
+  metadata.gz: 59aae6e64a0de758d4c6b9ce48793ee44ff16bbea0e79fe422c68d310c540f2517ba5202ec331410178d90d2e91bab3e7f6123134e07ba412d1f0fd2482f2a31
+  data.tar.gz: 266e0dde7325e20dc718b49107048e86e3cca96201a51d38c8613d7c410bd88e74273777e7766bc765b362e829555d56e003a6face19b9b0fa4eb83b46a5407f

data/README.md

@@ -16,7 +16,7 @@ rails g active_admin:resource Settingify::Setting
 
 Add this line to your application's Gemfile:
 
-    gem 'settingify', '0.0.2'
+    gem 'settingify', '0.0.4'
 
 And then execute:
 
@@ -24,7 +24,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install settingify -v 0.0.2
+    $ gem install settingify -v 0.0.4
 
 ### Post installation
 
@@ -96,6 +96,43 @@ the DB manually or run built-in rake task:
 bundle exec rake settingify:sync
 ```
 
+### Identifiing settings
+
+For some reason, e.g. in admin panel, you need to list all available
+settings. Also you want to provide humanized title and description for
+each setting separately. So for this from now `#title` and `#description`
+on `Settingify::Setting` exists. They provide localized values which can
+be defined using following key structure:
+
+```
+settingify.settings.{KEY}.{title/description}
+```
+
+### Grouping settings
+
+From _v0.0.4_ you can grouping settings. This feature does not affected
+on API for reading setting, so you must to define uniq setting names
+even in different groups. Grouping is a quite simple:
+
+```ruby
+Settingify.prepare_settings do
+  group :amazon_ses do
+    setting :amazon_ses_client_id
+  end
+end
+```
+
+By calling `Settingify.groups` you can get all defined groups. For each
+group you can get it's `#title` and defined `#settings` in concrete
+group. Title is localized and key has the following structure:
+
+```
+settingify.groups.{KEY}.title
+```
+
+Grouping was coming mainly for to be able to more clear render settings
+in admin panel but also with keeping in mind about next enhancements.
+
 ## Contributing
 
 1. Fork it ( https://github.com/alterego-labs/settingify/fork )

data/lib/settingify/builders/group.rb

@@ -0,0 +1,37 @@
+module Settingify
+  module Builders
+    class Group < Struct.new(:name, :block)
+      include SettingsPreparable
+
+      def self.call(*opts, &block)
+        new(*opts).call(&block)
+      end
+
+      def call(&block)
+        self.prepare_settings(&block)
+      end
+
+      def setting(name, type: String, default: '')
+        attach_to_group(name)
+        super
+      end
+
+      private
+
+      def attach_to_group(setting_key)
+        group = fetch_group
+        group.add setting_key
+      end
+
+      def fetch_group
+        Settingify.groups.find { |g| g.key == self.name } || define_new_group
+      end
+
+      def define_new_group
+        group = Settingify::Group.new(name)
+        Settingify.groups << group
+        group
+      end
+    end
+  end
+end

data/lib/settingify/dsl.rb

@@ -0,0 +1,31 @@
+module Settingify
+  module DSL
+    def setting(name, type: String, default: '')
+      setting_item = build_setting_item(name, type, default)
+      register_setting setting_item
+      define_setting setting_item
+    end
+
+    def group(name, &block)
+      Builders::Group.call(name, &block)
+    end
+
+    private
+
+    def build_setting_item(name, type, default)
+      RepoItem.new(name, type, default)
+    end
+
+    def define_setting(setting_item)
+      Settingify.singleton_class.instance_eval do
+        define_method setting_item.name do
+          Reader.new(setting_item).call
+        end
+      end
+    end
+
+    def register_setting(setting_item)
+      Settingify::Repos::Settings.instance.add setting_item
+    end
+  end
+end

data/lib/settingify/errors.rb

@@ -0,0 +1,3 @@
+module Settingify
+  PrepareSettingsWithoutBlockError = Class.new(StandardError)
+end

data/lib/settingify/group.rb

@@ -0,0 +1,25 @@
+module Settingify
+  class Group
+    attr_reader :key, :setting_keys
+
+    def initialize(key)
+      @setting_keys = []
+      @key = key
+    end
+
+    def add(setting_key)
+      @setting_keys = @setting_keys
+        .insert(-1, setting_key.to_sym)
+        .uniq
+      self
+    end
+
+    def title
+      I18n.t("settingify.groups.#{key}.title", self.key.to_s.humanize)
+    end
+
+    def settings
+      ::Settingify::Setting.where(key: setting_keys)
+    end
+  end
+end

data/lib/settingify/reader.rb

@@ -1,5 +1,7 @@
 module Settingify
-  class Reader < Struct.new(:key, :type, :default)
+  class Reader < Struct.new(:setting_item)
+    delegate :name, :type, :default, to: :setting_item
+
     def call
       return default unless table_exists?
       Caster.new(type, db_value).call
@@ -12,7 +14,7 @@ module Settingify
     end
 
     def db_setting
-      DbReader.new(key, default).call
+      DbReader.new(name, default).call
     end
 
     def db_value

data/lib/settingify/repo_item.rb

@@ -0,0 +1,4 @@
+module Settingify
+  class RepoItem < Struct.new(:name, :type, :default)
+  end
+end

data/lib/settingify/repos/settings.rb

@@ -0,0 +1,29 @@
+require 'singleton'
+
+module Settingify
+  module Repos
+    class Settings
+      include Singleton
+
+      def list
+        @settings_list ||= []
+        @settings_list
+      end
+
+      def add(item)
+        list << item
+      end
+
+      def clear!
+        list.each(&method(:undef_method_for))
+        list.clear
+      end
+
+      private
+
+      def undef_method_for(item)
+        Settingify.singleton_class.send :remove_method, item.name
+      end
+    end
+  end
+end

data/lib/settingify/setting.rb

@@ -1,5 +1,13 @@
 module Settingify
   class Setting < ActiveRecord::Base
     self.table_name_prefix = 'settingify_'
+
+    def title
+      I18n.t("settingify.settings.#{self.key}.title", self.key.to_s.humanize)
+    end
+
+    def description
+      I18n.t("settingify.settings.#{self.key}.description", "Description for #{self.key} setting...")
+    end
   end
 end

data/lib/settingify/settings_preparable.rb

@@ -0,0 +1,10 @@
+module Settingify
+  module SettingsPreparable
+    include DSL
+
+    def prepare_settings(&block)
+      raise Settingify::PrepareSettingsWithoutBlockError, 'Block must be passed!' unless block_given?
+      instance_eval(&block)
+    end
+  end
+end

data/lib/settingify/version.rb

@@ -1,3 +1,3 @@
 module Settingify
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/settingify.rb

@@ -5,33 +5,46 @@ require 'active_support/core_ext/module'
 require "settingify/version"
 
 require 'settingify/railtie' if defined?(Rails)
+require 'settingify/errors'
 
 module Settingify
   extend ActiveSupport::Autoload
 
   autoload :ContractExt
   autoload :Setting
-  autoload :SettingBuilder
-  autoload :SettingsList
+  autoload :DSL
   autoload :Reader
   autoload :Caster
   autoload :DbReader
   autoload :ActiveRecordHelpers
   autoload :Constants
   autoload :Repo
+  autoload :RepoItem
   autoload :DbSyncer
+  autoload :SettingsPreparable
+  autoload :Group
 
-  extend SettingBuilder
-  extend SettingsList
+  module Builders
+    extend ActiveSupport::Autoload
 
-  include Constants
+    autoload :Group
+  end
 
-  def self.prepare_settings(&block)
-    raise 'Block must be passed!' unless block_given?
-    instance_eval(&block)
+  module Repos
+    extend ActiveSupport::Autoload
+
+    autoload :Settings
   end
 
+  extend SettingsPreparable
+
+  include Constants
+
   def self.registered_settings
-    Repo.instance.list
+    Repos::Settings.instance.list
+  end
+
+  def self.groups
+    @_groups ||= []
   end
 end

data/settingify.gemspec

@@ -25,8 +25,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec",         "~> 3.0.0.beta"
-  spec.add_development_dependency "rspec-its",     "1.0.1"
+  spec.add_development_dependency "rspec",         "~> 3.4.0"
+  spec.add_development_dependency "rspec-its",     "1.2.0"
   spec.add_development_dependency "pry-nav",       "0.2.3"
   spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'json', '1.8.3'
 end

data/spec/lib/settingify/db_syncer_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 module SomeBuilder
-  extend Settingify::SettingBuilder
+  extend Settingify::DSL
 end
 
 describe Settingify::DbSyncer do
@@ -9,12 +9,12 @@ describe Settingify::DbSyncer do
 
   before do
     Settingify::Setting.delete_all
-    Settingify::Repo.instance.clear!
+    Settingify::Repos::Settings.instance.clear!
     SomeBuilder.setting :setting1, default: 'value1'
   end
 
   after do
-    Settingify::Repo.instance.clear!
+    Settingify::Repos::Settings.instance.clear!
   end
 
   context 'when setting does not exists in db' do

data/spec/lib/settingify/group_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Settingify::Group do
+  subject(:group) { described_class.new(:test_group) }
+
+  describe '#title' do
+    it 'provides localized title' do
+      expect(I18n).to receive(:t)
+      group.title
+    end
+  end
+
+  describe '#add' do
+    it 'adds setting by key into group' do
+      group.add :grouped_setting
+      setting_keys = group.instance_variable_get("@setting_keys")
+      expect(setting_keys).to include(:grouped_setting)
+    end
+  end
+end

data/spec/lib/settingify/reader_spec.rb

@@ -1,13 +1,20 @@
 require 'spec_helper'
 
 describe Settingify::Reader do
+  subject(:reader) { described_class.new(setting_item) }
+
+  let(:setting_item) { Settingify::RepoItem.new(key, type, default) }
+
   let(:key) { 'reader_setting' }
   let(:type) { String }
   let(:default) { 'reader_value' }
 
-  subject(:reader) { described_class.new(key, type, default) }
 
   context 'when table does not exists' do
+    before do
+      expect(reader).to receive(:table_exists?).and_return false
+    end
+
     it 'returns default value' do
       expect(reader.call).to eq default
     end

data/spec/lib/settingify/repo_item_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Settingify::RepoItem do
+  it { is_expected.to respond_to :name }
+  it { is_expected.to respond_to :type }
+  it { is_expected.to respond_to :default }
+end

data/spec/lib/settingify/{repo_spec.rb → repos/settings_spec.rb}

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
 module SomeBuilder
-  extend Settingify::SettingBuilder
+  extend Settingify::DSL
 end
 
-describe Settingify::Repo do
+describe Settingify::Repos::Settings do
   subject(:repo) { described_class.send :new }
 
   describe '#list' do
@@ -33,7 +33,7 @@ describe Settingify::Repo do
     end
   end
 
-  describe '#clear' do
+  describe '#clear!' do
     before do
       SomeBuilder.setting(:for_clear_setting)
     end
@@ -41,7 +41,7 @@ describe Settingify::Repo do
     it 'removes all settings' do
       expect(Settingify).to respond_to :for_clear_setting
       expect(Settingify.registered_settings).to_not be_empty
-      Settingify::Repo.instance.clear!
+      Settingify::Repos::Settings.instance.clear!
       expect(Settingify).to_not respond_to :for_clear_setting
       expect(Settingify.registered_settings).to be_empty
     end

data/spec/lib/settingify/setting_builder_spec.rb

@@ -1,21 +1,33 @@
 require 'spec_helper'
 
 module SomeBuilder
-  extend Settingify::SettingBuilder
+  extend Settingify::DSL
 end
 
-describe Settingify::SettingBuilder do
-  describe 'defining settings' do
-    it 'successfully' do
-      SomeBuilder.setting(:some_setting)
-      expect(Settingify.some_setting).to eq ''
-    end
+describe Settingify::DSL do
+  describe '#setting' do
+    describe 'defining settings' do
+      it 'successfully' do
+        SomeBuilder.setting(:some_setting)
+        expect(Settingify.some_setting).to eq ''
+      end
 
-    context 'when default is Integer' do
-      it 'returns integer value' do
-        SomeBuilder.setting :some_int_value, type: :integer, default: 12
-        expect(Settingify.some_int_value).to eq 12
+      context 'when default is Integer' do
+        it 'returns integer value' do
+          SomeBuilder.setting :some_int_value, type: :integer, default: 12
+          expect(Settingify.some_int_value).to eq 12
+        end
       end
     end
   end
+
+  describe '#group' do
+    let(:block) { ->{ } }
+
+    it 'calls group builder properly' do
+      expect(Settingify::Builders::Group).to receive(:call).with(:another_group)
+
+      SomeBuilder.group :another_group, &block
+    end
+  end
 end

data/spec/lib/settingify/setting_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Settingify::Setting do
+  subject(:setting) { described_class.new(key: :cool_setting) }
+
+  describe '#title' do
+    it 'returns setting title' do
+      expect(setting.title).to_not be_blank
+    end
+  end
+
+  describe '#description' do
+    it 'returns setting description' do
+      expect(setting.description).to_not be_blank
+    end
+  end
+end

data/spec/lib/settingify_spec.rb

@@ -6,7 +6,7 @@ describe Settingify do
       it 'raises exception' do
         expect{
           Settingify.prepare_settings
-        }.to raise_exception
+        }.to raise_error(Settingify::PrepareSettingsWithoutBlockError)
       end
     end
 
@@ -22,8 +22,37 @@ describe Settingify do
 
   describe '.registered_settings' do
     it 'calls list on repo' do
-      expect(Settingify::Repo).to receive_message_chain(:instance, :list)
+      expect(Settingify::Repos::Settings).to receive_message_chain(:instance, :list)
       Settingify.registered_settings
     end
   end
+
+  context 'real testing' do
+    before(:each) do
+      Settingify::Repos::Settings.instance.clear!
+    end
+
+    describe 'grouped settings' do
+      before(:each) do
+        Settingify.prepare_settings do
+          setting :ungrouped_setting
+
+          group :group1 do
+            setting :grouped_setting, default: :grouped_value
+          end
+        end
+      end
+
+      it 'defines grouped setting as well as ungrouped one' do
+        expect(Settingify).to respond_to(:ungrouped_setting)
+        expect(Settingify).to respond_to(:grouped_setting)
+      end
+
+      it 'defines new group' do
+        expect(Settingify.groups.count).to eq 1
+        group = Settingify.groups.first
+        expect(group.key).to eq :group1
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: settingify
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Sergey Gernyak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-30 00:00:00.000000000 Z
+date: 2016-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -100,28 +100,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta
+        version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.3
 description: System for managing global settings trough database
 email:
 - sergeg1990@gmail.com
@@ -167,25 +181,32 @@ files:
 - lib/generators/settingify/install/templates/settingify.rb
 - lib/settingify.rb
 - lib/settingify/active_record_helpers.rb
+- lib/settingify/builders/group.rb
 - lib/settingify/caster.rb
 - lib/settingify/constants.rb
 - lib/settingify/contract_ext.rb
 - lib/settingify/db_reader.rb
 - lib/settingify/db_syncer.rb
+- lib/settingify/dsl.rb
+- lib/settingify/errors.rb
+- lib/settingify/group.rb
 - lib/settingify/railtie.rb
 - lib/settingify/reader.rb
-- lib/settingify/repo.rb
+- lib/settingify/repo_item.rb
+- lib/settingify/repos/settings.rb
 - lib/settingify/setting.rb
-- lib/settingify/setting_builder.rb
-- lib/settingify/settings_list.rb
+- lib/settingify/settings_preparable.rb
 - lib/settingify/tasks/settingify.rake
 - lib/settingify/version.rb
 - settingify.gemspec
 - spec/db/schema.rb
 - spec/lib/settingify/db_syncer_spec.rb
+- spec/lib/settingify/group_spec.rb
 - spec/lib/settingify/reader_spec.rb
-- spec/lib/settingify/repo_spec.rb
+- spec/lib/settingify/repo_item_spec.rb
+- spec/lib/settingify/repos/settings_spec.rb
 - spec/lib/settingify/setting_builder_spec.rb
+- spec/lib/settingify/setting_spec.rb
 - spec/lib/settingify_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/alterego-labs/settingify
@@ -208,15 +229,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Global setting system for Rails
 test_files:
 - spec/db/schema.rb
 - spec/lib/settingify/db_syncer_spec.rb
+- spec/lib/settingify/group_spec.rb
 - spec/lib/settingify/reader_spec.rb
-- spec/lib/settingify/repo_spec.rb
+- spec/lib/settingify/repo_item_spec.rb
+- spec/lib/settingify/repos/settings_spec.rb
 - spec/lib/settingify/setting_builder_spec.rb
+- spec/lib/settingify/setting_spec.rb
 - spec/lib/settingify_spec.rb
 - spec/spec_helper.rb

data/lib/settingify/repo.rb

@@ -1,27 +0,0 @@
-require 'singleton'
-
-module Settingify
-  class Repo
-    include Singleton
-
-    def list
-      @settings_list ||= []
-      @settings_list
-    end
-
-    def add(item)
-      list << item
-    end
-
-    def clear!
-      list.each(&method(:undef_method_for))
-      list.clear
-    end
-
-    private
-
-    def undef_method_for(item)
-      Settingify::SettingsList.send :remove_method, item.name
-    end
-  end
-end

data/lib/settingify/setting_builder.rb

@@ -1,20 +0,0 @@
-module Settingify
-  module SettingBuilder
-    def setting(name, type: String, default: '')
-      register_setting name, type, default
-      define_setting name, type, default
-    end
-
-    private
-
-    def define_setting(name, type, default)
-      SettingsList.send :define_method, name do
-        Reader.new(name, type, default).call
-      end
-    end
-
-    def register_setting(name, type, default)
-      Settingify::Repo.instance.add OpenStruct.new(name: name, type: type, default: default)
-    end
-  end
-end

data/lib/settingify/settings_list.rb

@@ -1,4 +0,0 @@
-module Settingify
-  module SettingsList
-  end
-end