rails-settings-ui 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23b3fb25f9bb4d3f397e71a0e65358869ca63f2b
-  data.tar.gz: 6ed56614f5e2f6eea5d97c4414d14f9ee2580ad2
+  metadata.gz: 1bd37d900e097cdee839f64abed32539038d2c4f
+  data.tar.gz: 58a2060c7fc0c73ed046a811386dfd09da345c91
 SHA512:
-  metadata.gz: da0612bdb5060da129a2092c55d71e861ae8eebae4fa819d8dcfd670ea83d84c425c95fababd39c29c71b3ef613035257d0a7c08963a53a3bf5ae606f36c1a05
-  data.tar.gz: 407a41786a292a92209256efecba8603353d5418dba7dcce8c9e73e11bfa6afb3153fd00aec2e1b755420c21aaf4f7179142f9d74ec588a6108fe6ebd50d9900
+  metadata.gz: 97867588d71608cd5354396f6162d1b93c512327db2f90306cfe60d7e665cadf5646800265302b866529a874f1e7deb48572133406b24529c237f004893352e4
+  data.tar.gz: 73c09c67f469370b1dd8f29e0a385fc47bf7d69f874319e35b6fa04857b81a65e65431a04c9e45982818b075b94cef55493fb304f377eee02ca13be6d38fbe2b

data/Gemfile

@@ -4,4 +4,6 @@ gemspec
 
 group :development, :test do
   gem "sqlite3"
+  gem "rails-settings-cached"
+  gem "haml-rails"
 end

data/Rakefile

@@ -6,16 +6,17 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rake'
-require 'rake/rdoctask'
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
 
-require 'rake/testtask'
+Bundler::GemHelper.install_tasks
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
 
-task :default => :test
+task :default => :spec

data/app/assets/stylesheets/rails_settings_ui/application.css.scss

@@ -1,4 +1,4 @@
 /*
- *= require bootstrap_and_overrides
+ *= require ./bootstrap_and_overrides
  *= require_self
-*/
+*/

data/app/controllers/rails_settings_ui/settings_controller.rb

@@ -23,6 +23,6 @@ class RailsSettingsUi::SettingsController < RailsSettingsUi::ApplicationControll
   end
 
   def cast_settings_params
-    @casted_settings = RailsSettingsUi::SettingsHelper.cast(params["settings"])
+    @casted_settings = RailsSettingsUi::TypeConverter.cast(params["settings"])
   end
 end

data/app/helpers/rails_settings_ui/settings_helper.rb

@@ -1,75 +1,44 @@
 module RailsSettingsUi::SettingsHelper
-  def self.cast(requires_cast)
-    requires_cast[:errors] = {}
-    requires_cast.each do |var_name, value|
-      case Settings.defaults[var_name.to_sym]
-        when Fixnum
-          if is_numeric?(value)
-            requires_cast[var_name] = value.to_i
-          else
-            requires_cast[:errors][var_name.to_sym] = I18n.t("settings.errors.invalid_numeric", default: 'Invalid')
-          end
-        when ActiveSupport::HashWithIndifferentAccess
-          begin
-            requires_cast[var_name] = JSON.parse(value.gsub(/\=\>/, ':'))
-          rescue JSON::ParserError => e
-            requires_cast[:errors][var_name.to_sym] = I18n.t("settings.errors.invalid_hash", default: 'Invalid')
-          end
-        when Float
-          if is_numeric?(value)
-            requires_cast[var_name] = value.to_f
-          else
-            requires_cast[:errors][var_name.to_sym] = I18n.t("settings.errors.invalid_numeric", default: 'Invalid')
-          end
-        when Array
-          # Array presented in checkboxes
-          if value.is_a?(Hash)
-            requires_cast[var_name] = value.keys.map!(&:to_sym)
-          # or in select tag
-          else
-            value.to_sym
-          end
-        when FalseClass, TrueClass
-          requires_cast[var_name] = true
-      end
-    end
-    Settings.defaults.each do |name, value|
-      if !requires_cast[name.to_sym].present? && [TrueClass, FalseClass].include?(value.class)
-        requires_cast[name.to_sym] = false
-      end
-    end
-
-    requires_cast
-  end
-
   def setting_field(setting_name, setting_value, all_settings)
     if RailsSettingsUi.settings_displayed_as_select_tag.include?(setting_name.to_sym)
-      default_setting_values = I18n.t("settings.attributes.#{setting_name}.labels", default: {}).map do |label, value|
-        [label, value]
-      end
-      select_tag("settings[#{setting_name.to_s}]", options_for_select(default_setting_values, setting_value))
+      select_tag_field(setting_name, setting_value)
     elsif setting_value.is_a?(Array)
-      field = ""
-      Settings.defaults[setting_name.to_sym].each do |value|
-        field << check_box_tag("settings[#{setting_name.to_s}][#{value.to_s}]", nil, all_settings[setting_name.to_s].include?(value), style: "margin: 0 10px;")
-        field << label_tag("settings[#{setting_name.to_s}][#{value.to_s}]", I18n.t("settings.attributes.#{setting_name}.labels.#{value}", default: value.to_s), style: "display: inline-block;")
-      end
-      return field.html_safe
+      checkboxes_group_field(setting_name, all_settings)
     elsif [TrueClass, FalseClass].include?(setting_value.class)
-      return check_box_tag("settings[#{setting_name.to_s}]", nil, setting_value).html_safe
+      checkbox_field(setting_name, setting_value)
     else
-      text_field = if setting_value.to_s.size > 30
-        text_area_tag("settings[#{setting_name}]", setting_value.to_s, rows: 10)
-      else
-        text_field_tag("settings[#{setting_name}]", setting_value.to_s)
-      end
+      text_field(setting_name, setting_value)
+    end
+  end
 
-      help_block_content = I18n.t("settings.attributes.#{setting_name}.help_block", default: '')
-      text_field + (help_block_content.presence && content_tag(:span, help_block_content, class: 'help-block'))
+  def select_tag_field(setting_name, setting_value)
+    default_setting_values = I18n.t("settings.attributes.#{setting_name}.labels", default: {}).map do |label, value|
+      [label, value]
     end
+    select_tag("settings[#{setting_name.to_s}]", options_for_select(default_setting_values, setting_value))
   end
 
-  def self.is_numeric?(value)
-    !value.to_s.match(/\A[+-]?\d+?(\.\d+)?\Z/).nil?
+  def checkboxes_group_field(setting_name, all_settings)
+    field = ""
+    Settings.defaults[setting_name.to_sym].each do |value|
+      field << check_box_tag("settings[#{setting_name.to_s}][#{value.to_s}]", nil, all_settings[setting_name.to_s].include?(value), style: "margin: 0 10px;")
+      field << label_tag("settings[#{setting_name.to_s}][#{value.to_s}]", I18n.t("settings.attributes.#{setting_name}.labels.#{value}", default: value.to_s), style: "display: inline-block;")
+    end
+    field.html_safe
+  end
+
+  def checkbox_field(setting_name, setting_value)
+    check_box_tag("settings[#{setting_name.to_s}]", nil, setting_value).html_safe
+  end
+
+  def text_field(setting_name, setting_value)
+    field = if setting_value.to_s.size > 30
+      text_area_tag("settings[#{setting_name}]", setting_value.to_s, rows: 10)
+    else
+      text_field_tag("settings[#{setting_name}]", setting_value.to_s)
+    end
+
+    help_block_content = I18n.t("settings.attributes.#{setting_name}.help_block", default: '')
+    field + (help_block_content.presence && content_tag(:span, help_block_content, class: 'help-block'))
   end
 end

data/lib/rails-settings-ui.rb

@@ -3,7 +3,7 @@ require 'rails-settings-ui/engine'
 require 'rails-settings-ui/main_app_route_delegator'
 require 'rails-settings-ui/version'
 
-require 'rails-settings-cached'
+require "rails-settings-ui/type_converter"
 
 module RailsSettingsUi
   mattr_accessor :parent_controller

data/lib/rails-settings-ui/engine.rb

@@ -1,5 +1,12 @@
 module ::RailsSettingsUi
   class Engine < Rails::Engine
     isolate_namespace RailsSettingsUi
+
+    config.generators do |g|
+      g.test_framework      :rspec,        fixture: false
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+      g.assets false
+      g.helper false
+    end
   end
 end

data/lib/rails-settings-ui/type_converter.rb

@@ -0,0 +1,58 @@
+require_relative "value_types/string"
+require_relative "value_types/symbol"
+require_relative "value_types/fixnum"
+require_relative "value_types/hash"
+require_relative "value_types/float"
+require_relative "value_types/array"
+require_relative "value_types/boolean"
+
+module RailsSettingsUi
+  class UnknownDefaultValueType < StandardError;end
+
+  class TypeConverter
+    VALUE_TYPES_MAP = {
+      String => RailsSettingsUi::ValueTypes::String,
+      Symbol => RailsSettingsUi::ValueTypes::Symbol,
+      Fixnum => RailsSettingsUi::ValueTypes::Fixnum,
+      ActiveSupport::HashWithIndifferentAccess => RailsSettingsUi::ValueTypes::Hash,
+      Float => RailsSettingsUi::ValueTypes::Float,
+      Array => RailsSettingsUi::ValueTypes::Array,
+      FalseClass => RailsSettingsUi::ValueTypes::Boolean,
+      TrueClass => RailsSettingsUi::ValueTypes::Boolean
+    }
+
+    def self.cast(settings)
+      errors = {}
+      settings.each do |name, value|
+        type = setting_value_type(name, value)
+        settings[name] = type.cast
+        if type.errors.any?
+          errors[name.to_sym] = type.errors
+        end
+      end
+      settings = set_non_presented_boolean_settings_to_false(settings)
+
+      settings[:errors] = errors
+      settings
+    end
+
+    def self.setting_value_type(name, value)
+      default_setting_value_type = Settings.defaults[name.to_sym].class
+      unless VALUE_TYPES_MAP.keys.include?(default_setting_value_type)
+        raise RailsSettingsUi::UnknownDefaultValueType, "Unknown default value type #{default_setting_value_type}"
+      end
+
+      setting_value_type_class = VALUE_TYPES_MAP[default_setting_value_type]
+      setting_value_type_class.new(value)
+    end
+
+    def self.set_non_presented_boolean_settings_to_false(settings)
+      Settings.defaults.each do |name, value|
+        if !settings[name.to_sym].present? && [TrueClass, FalseClass].include?(value.class)
+          settings[name.to_sym] = false
+        end
+      end
+      settings
+    end
+  end
+end

data/lib/rails-settings-ui/value_types/array.rb

@@ -0,0 +1,17 @@
+require_relative "base"
+
+module RailsSettingsUi
+  module ValueTypes
+    class Array < RailsSettingsUi::ValueTypes::Base
+      def cast
+        # Array presented in checkboxes
+        if ["Hash", "ActiveSupport::HashWithIndifferentAccess"].include?(value.class.name)
+          value.keys.map!(&:to_sym)
+        # or in select tag
+        else
+          value.to_sym
+        end
+      end
+    end
+  end
+end

data/lib/rails-settings-ui/value_types/base.rb

@@ -0,0 +1,30 @@
+module RailsSettingsUi
+  module ValueTypes
+    class Base
+      attr_accessor :value, :errors
+    
+      def initialize(value)
+        self.value = value
+        self.errors = []
+        validate
+      end
+    
+      def cast
+        raise NotImplementedError
+      end
+    
+      def valid?
+        !errors.any?
+      end
+
+      def value_numeric?
+        !value.to_s.match(/\A[+-]?\d+?(\.\d+)?\Z/).nil?
+      end
+    
+      protected
+    
+      def validate
+      end
+    end
+  end
+end

data/lib/rails-settings-ui/value_types/boolean.rb

@@ -0,0 +1,11 @@
+require_relative "base"
+
+module RailsSettingsUi
+  module ValueTypes
+    class Boolean < RailsSettingsUi::ValueTypes::Base
+      def cast
+        self.value = true
+      end
+    end
+  end
+end

data/lib/rails-settings-ui/value_types/fixnum.rb

@@ -0,0 +1,17 @@
+require_relative "base"
+
+module RailsSettingsUi
+  module ValueTypes
+    class Fixnum < RailsSettingsUi::ValueTypes::Base
+      def cast
+        value.to_i
+      end
+    
+      def validate
+        unless value_numeric?
+          self.errors << I18n.t("settings.errors.invalid_numeric", default: 'Invalid')
+        end
+      end
+    end
+  end
+end

data/lib/rails-settings-ui/value_types/float.rb

@@ -0,0 +1,17 @@
+require_relative "base"
+
+module RailsSettingsUi
+  module ValueTypes
+    class Float < RailsSettingsUi::ValueTypes::Base
+      def cast
+        value.to_f
+      end
+    
+      def validate
+        unless value_numeric?
+          self.errors << I18n.t("settings.errors.invalid_numeric", default: 'Invalid')
+        end
+      end
+    end
+  end
+end

data/lib/rails-settings-ui/value_types/hash.rb

@@ -0,0 +1,19 @@
+require_relative "base"
+
+module RailsSettingsUi
+  module ValueTypes
+    class Hash < RailsSettingsUi::ValueTypes::Base
+      def cast
+        value
+      end
+
+      def validate
+        begin
+          self.value = JSON.parse(value.gsub(/\=\>/, ':'))
+        rescue JSON::ParserError => e
+          self.errors << I18n.t("settings.errors.invalid_hash", default: 'Invalid')
+        end
+      end
+    end
+  end
+end

data/lib/rails-settings-ui/value_types/string.rb

@@ -0,0 +1,11 @@
+require_relative "base"
+
+module RailsSettingsUi
+  module ValueTypes
+    class String < RailsSettingsUi::ValueTypes::Base
+      def cast
+        value.to_s
+      end
+    end
+  end
+end

data/lib/rails-settings-ui/value_types/symbol.rb

@@ -0,0 +1,11 @@
+require_relative "base"
+
+module RailsSettingsUi
+  module ValueTypes
+    class Symbol < RailsSettingsUi::ValueTypes::Base
+      def cast
+        value.to_sym
+      end
+    end
+  end
+end

data/lib/rails-settings-ui/version.rb

@@ -1,3 +1,3 @@
 module RailsSettingsUi
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks