settingify 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94d92a3f44c051e69e85ffaec7d69028ec7ed1f8
-  data.tar.gz: 0ef9c8d16d8c5fc549fc30ac0867db0b4f6f3339
+  metadata.gz: 78917b39693aa3208f0b77624d23c7d516fb05f4
+  data.tar.gz: 61fc063e16226665cac720deec8892c47c5c773b
 SHA512:
-  metadata.gz: 59aae6e64a0de758d4c6b9ce48793ee44ff16bbea0e79fe422c68d310c540f2517ba5202ec331410178d90d2e91bab3e7f6123134e07ba412d1f0fd2482f2a31
-  data.tar.gz: 266e0dde7325e20dc718b49107048e86e3cca96201a51d38c8613d7c410bd88e74273777e7766bc765b362e829555d56e003a6face19b9b0fa4eb83b46a5407f
+  metadata.gz: 483dd18811eaa3a63c23bc641a2e01c9619afbecfb62ceb94bd7e3d07054163af91fb33219ea289b890c6f2ca0560ee34ce5016261b2f066f6e984264354362d
+  data.tar.gz: 58f61a3f792544c114b4adf814c282ea570aa2498f615366bcf14f72751ef6ee489f1e5345e1686964cc924aa7d699e41c174783991b85935e00be6828d0aa27

data/.gitignore

@@ -21,3 +21,5 @@ tmp
 *.a
 mkmf.log
 .rvmrc
+tmp
+spec/tmp

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.4'
+    gem 'settingify', '0.0.5'
 
 And then execute:
 
@@ -24,7 +24,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install settingify -v 0.0.4
+    $ gem install settingify -v 0.0.5
 
 ### Post installation
 
@@ -133,6 +133,31 @@ 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.
 
+## Localization feature
+
+[Read there](https://github.com/alterego-labs/settingify/wiki/Localization-feature)
+
+## Testing
+
+Because localization feature affects on Setting class by unchangable
+traco logic includance to run all specs you must run several commands:
+
+```
+rspec spec/lib
+```
+
+and
+
+```
+rspec spec/localized_settingify_spec.rb
+```
+
+Or you can run they by single command:
+
+```
+rake spec
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/alterego-labs/settingify/fork )

data/Rakefile

@@ -2,9 +2,14 @@ require "rubygems"
 require 'rspec/core/rake_task'
 require 'rubygems/specification'
 
-task default: :spec
 desc "Run specs"
-RSpec::Core::RakeTask.new do |t|
-  t.pattern = FileList['spec/**/*_spec.rb']
-  t.rspec_opts = %w(--color)
+task :spec do
+  RSpec::Core::RakeTask.new do |t|
+    t.pattern = FileList['spec/lib/**/*_spec.rb']
+    t.rspec_opts = %w(--colour)
+  end
+  RSpec::Core::RakeTask.new do |t|
+    t.pattern = FileList['spec/localized_settingify_spec.rb']
+    t.rspec_opts = %w(--colour)
+  end
 end

data/lib/generators/settingify/install/install_generator.rb

@@ -7,6 +7,9 @@ module Settingify
       source_root File.expand_path('../templates', __FILE__)
       desc "Add migration and copy initializer"
 
+      class_option :localization, type: :boolean, default: false, desc: 'Enable or disable localization feature.'
+      class_option :locales, type: :string, default: '', desc: 'List of available locales. Separated by comma'
+
       def self.next_migration_number(path)
         unless @prev_migration_nr
           @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
@@ -16,8 +19,19 @@ module Settingify
         @prev_migration_nr.to_s
       end
 
+      def setup_localization
+        if options[:localization]
+          Settingify.config do |config|
+            config.localization do |localization|
+              localization.active = options[:localization]
+              localization.available_locales = options[:locales].split(',').map(&:to_sym)
+            end
+          end
+        end
+      end
+
       def copy_migrations
-        migration_template "create_settingify_setting.rb", "db/migrate/create_settingify_setting.rb"
+        migration_template "create_settingify_setting.rb.erb", "db/migrate/create_settingify_setting.rb"
       end
 
       def copy_initializer

data/lib/generators/settingify/install/templates/create_settingify_setting.rb.erb

@@ -0,0 +1,16 @@
+class CreateSettingifySetting < ActiveRecord::Migration
+  def change
+    create_table Settingify::TABLE_NAME do |t|
+      t.string :key
+      t.string :description
+      <% if Settingify.config.localization.active %>
+        <% Settingify.config.localization.available_locales.each do |locale| %>
+          <%= "t.string :value_#{locale}" %>
+        <% end %>
+      <% else %>
+        t.string :value
+      <% end %>
+      t.timestamps
+    end
+  end
+end

data/lib/generators/settingify/install/templates/settingify.rb

@@ -1,4 +1,19 @@
+Settingify.config do |config|
+  # Uncomment if you want to use localization feature.
+  # For more information visit `lib/settingify/configs/localization.rb`
+  #
+  #config.localization do |localization|
+    #localization.active            = false
+    #localization.available_locales = []
+  #end
+end
+
 Settingify.prepare_settings do
-  # Your settings will be here
+  # # Your settings will be here:
   # setting :my_setting, type: String, default: 'msg'
+  #
+  # # or you may to define grouped settings:
+  # group :general do
+  #   setting :grouped_setting, default: 'grouped_setting_value'
+  # end
 end

data/lib/settingify/configs/localization.rb

@@ -0,0 +1,32 @@
+module Settingify
+  module Configs
+    class Localization
+      #
+      # Specifies if localization feature either is active or not.
+      #
+      # Values:
+      # true/false
+      #
+      # Default:
+      # false
+      #
+      attr_accessor :active
+
+      #
+      # Contains locales array for that settingify must provides localized settings.
+      #
+      # Values:
+      # array of symbols
+      #
+      # Default:
+      # empty array
+      #
+      attr_accessor :available_locales
+
+      def initialize
+        @active            = false
+        @available_locales = []
+      end
+    end
+  end
+end

data/lib/settingify/configs/main.rb

@@ -0,0 +1,10 @@
+module Settingify
+  module Configs
+    class Main
+      def localization(&block)
+        @_localization_config ||= Configs::Localization.new
+        block_given? ? yield(@_localization_config) : @_localization_config
+      end
+    end
+  end
+end

data/lib/settingify/setting.rb

@@ -2,6 +2,10 @@ module Settingify
   class Setting < ActiveRecord::Base
     self.table_name_prefix = 'settingify_'
 
+    if Settingify.config.localization.active
+      translates :value, fallback: false
+    end
+
     def title
       I18n.t("settingify.settings.#{self.key}.title", self.key.to_s.humanize)
     end

data/lib/settingify/version.rb

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

data/lib/settingify.rb

@@ -7,6 +7,8 @@ require "settingify/version"
 require 'settingify/railtie' if defined?(Rails)
 require 'settingify/errors'
 
+require 'traco'
+
 module Settingify
   extend ActiveSupport::Autoload
 
@@ -36,10 +38,22 @@ module Settingify
     autoload :Settings
   end
 
+  module Configs
+    extend ActiveSupport::Autoload
+
+    autoload :Main
+    autoload :Localization
+  end
+
   extend SettingsPreparable
 
   include Constants
 
+  def self.config(&block)
+    @_main_config ||= Configs::Main.new
+    block_given? ? yield(@_main_config) : @_main_config
+  end
+
   def self.registered_settings
     Repos::Settings.instance.list
   end

data/settingify.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "traco", "3.1.6"
+
   spec.add_development_dependency "activesupport",  ">= 4.0.4"
   spec.add_development_dependency "activerecord",   ">= 4.0.4"
   spec.add_development_dependency "activemodel",    ">= 4.0.4"
@@ -29,5 +31,7 @@ Gem::Specification.new do |spec|
   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 'generator_spec', '0.9.3'
+
   spec.add_development_dependency 'json', '1.8.3'
 end

data/spec/db/localized_schema.rb

@@ -0,0 +1,10 @@
+ActiveRecord::Schema.define do
+  create_table "settingify_settings", force: true do |t|
+    t.string   "key"
+    t.string   "value_fr"
+    t.string   "value_nl"
+    t.string   "description"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+end

data/spec/lib/generators/settingify/install/install_generator_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+require File.join(Dir.pwd, 'lib/generators/settingify/install/install_generator.rb')
+
+describe Settingify::Generators::InstallGenerator, type: :generator do
+  destination File.expand_path("../../../../../tmp", __FILE__)
+
+  context 'when localization is disabled' do
+    before do
+      prepare_destination
+      run_generator
+    end
+
+    specify do
+      expect(destination_root).to have_structure {
+        directory 'config' do
+          directory 'initializers' do
+            file 'settingify.rb' do
+              contains "Settingify.config"
+              contains "Settingify.prepare_settings"
+            end
+          end
+        end
+        directory 'db' do
+          directory 'migrate' do
+            migration 'create_settingify_setting' do
+              contains "t.string :value"
+            end
+          end
+        end
+      }
+    end
+  end
+
+  context 'when localization is enabled' do
+    before do
+      Settingify.config.localization.available_locales = [:fr, :nl]
+      Settingify.config.localization.active = true
+      prepare_destination
+      run_generator
+    end
+
+    after do
+      Settingify.config.localization.available_locales = []
+      Settingify.config.localization.active = false
+    end
+
+    specify do
+      expect(destination_root).to have_structure {
+        directory 'config' do
+          directory 'initializers' do
+            file 'settingify.rb' do
+              contains "Settingify.config"
+              contains "Settingify.prepare_settings"
+            end
+          end
+        end
+        directory 'db' do
+          directory 'migrate' do
+            migration 'create_settingify_setting' do
+              contains "t.string :value_fr"
+              contains "t.string :value_nl"
+            end
+          end
+        end
+      }
+    end
+  end
+end

data/spec/lib/settingify/configs/localization_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Settingify::Configs::Localization do
+  describe 'default values' do
+    subject { described_class.new }
+
+    its(:active) { is_expected.to be_falsey }
+    its(:available_locales) { is_expected.to be_empty }
+  end
+
+  describe 'available attributes' do
+    it { is_expected.to respond_to :active= }
+    it { is_expected.to respond_to :available_locales= }
+  end
+end

data/spec/lib/settingify/configs/main_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Settingify::Configs::Main do
+  it { is_expected.to respond_to :localization }
+end

data/spec/localized_settingify_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+class Settingify::Setting
+  translates :value, fallback: false
+end
+
+describe Settingify do
+  context 'localized feature' do
+    before do
+      load 'spec/db/localized_schema.rb'
+      Settingify.config do |config|
+        config.localization do |localization|
+          localization.active = true
+          localization.available_locales = [:fr, :nl]
+        end
+      end
+      Settingify::Repos::Settings.instance.clear!
+      I18n.locale = :fr
+      Settingify::Setting.create(key: :localized, value: :fr_localized)
+      Settingify.prepare_settings do
+        setting :localized, default: :unlocalized
+      end
+    end
+
+    after do
+      Settingify.config do |config|
+        config.localization do |localization|
+          localization.active = false
+        end
+      end
+    end
+
+    context 'when current locale is nl' do
+      it 'returns blank string' do
+        I18n.locale = :nl
+        expect(Settingify.localized).to be_blank
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
 load 'db/schema.rb'
 
 require 'rspec/its'
+require 'generator_spec'
 require 'settingify'
 require 'pry-nav'
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: settingify
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Sergey Gernyak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-14 00:00:00.000000000 Z
+date: 2016-01-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: traco
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.6
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.3
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -177,12 +205,14 @@ files:
 - README.md
 - Rakefile
 - lib/generators/settingify/install/install_generator.rb
-- lib/generators/settingify/install/templates/create_settingify_setting.rb
+- lib/generators/settingify/install/templates/create_settingify_setting.rb.erb
 - 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/configs/localization.rb
+- lib/settingify/configs/main.rb
 - lib/settingify/constants.rb
 - lib/settingify/contract_ext.rb
 - lib/settingify/db_reader.rb
@@ -199,7 +229,11 @@ files:
 - lib/settingify/tasks/settingify.rake
 - lib/settingify/version.rb
 - settingify.gemspec
+- spec/db/localized_schema.rb
 - spec/db/schema.rb
+- spec/lib/generators/settingify/install/install_generator_spec.rb
+- spec/lib/settingify/configs/localization_spec.rb
+- spec/lib/settingify/configs/main_spec.rb
 - spec/lib/settingify/db_syncer_spec.rb
 - spec/lib/settingify/group_spec.rb
 - spec/lib/settingify/reader_spec.rb
@@ -208,6 +242,7 @@ files:
 - spec/lib/settingify/setting_builder_spec.rb
 - spec/lib/settingify/setting_spec.rb
 - spec/lib/settingify_spec.rb
+- spec/localized_settingify_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/alterego-labs/settingify
 licenses:
@@ -234,7 +269,11 @@ signing_key:
 specification_version: 4
 summary: Global setting system for Rails
 test_files:
+- spec/db/localized_schema.rb
 - spec/db/schema.rb
+- spec/lib/generators/settingify/install/install_generator_spec.rb
+- spec/lib/settingify/configs/localization_spec.rb
+- spec/lib/settingify/configs/main_spec.rb
 - spec/lib/settingify/db_syncer_spec.rb
 - spec/lib/settingify/group_spec.rb
 - spec/lib/settingify/reader_spec.rb
@@ -243,4 +282,5 @@ test_files:
 - spec/lib/settingify/setting_builder_spec.rb
 - spec/lib/settingify/setting_spec.rb
 - spec/lib/settingify_spec.rb
+- spec/localized_settingify_spec.rb
 - spec/spec_helper.rb

data/lib/generators/settingify/install/templates/create_settingify_setting.rb

@@ -1,10 +0,0 @@
-class CreateSettingifySetting < ActiveRecord::Migration
-  def change
-    create_table Settingify::TABLE_NAME do |t|
-      t.string :key
-      t.string :value
-      t.string :description
-      t.timestamps
-    end
-  end
-end