setting_accessors 0.3.0 → 1.0.0

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.2.gemfile.lock

@@ -0,0 +1,177 @@
+PATH
+  remote: ..
+  specs:
+    setting_accessors (1.0.0)
+      activemodel (>= 4.2, <= 5.2)
+      activerecord (>= 4.2, <= 5.2)
+      activesupport (>= 4.2, <= 5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.0)
+      actionpack (= 5.2.0)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.0)
+      actionpack (= 5.2.0)
+      actionview (= 5.2.0)
+      activejob (= 5.2.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.0)
+      actionview (= 5.2.0)
+      activesupport (= 5.2.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.0)
+      activesupport (= 5.2.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.0)
+      activesupport (= 5.2.0)
+      globalid (>= 0.3.6)
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activestorage (5.2.0)
+      actionpack (= 5.2.0)
+      activerecord (= 5.2.0)
+      marcel (~> 0.3.1)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (9.0.0)
+    ast (2.4.0)
+    builder (3.2.3)
+    concurrent-ruby (1.1.3)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.7.1)
+    generator_spec (0.9.4)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.1)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.2)
+    mini_mime (1.0.1)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nio4r (2.3.1)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rack (2.0.6)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.0)
+      actioncable (= 5.2.0)
+      actionmailer (= 5.2.0)
+      actionpack (= 5.2.0)
+      actionview (= 5.2.0)
+      activejob (= 5.2.0)
+      activemodel (= 5.2.0)
+      activerecord (= 5.2.0)
+      activestorage (= 5.2.0)
+      activesupport (= 5.2.0)
+      bundler (>= 1.3.0)
+      railties (= 5.2.0)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.0)
+      actionpack (= 5.2.0)
+      activesupport (= 5.2.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.60.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.13)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.4.0)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+    with_model (2.1.2)
+      activerecord (>= 4.2, < 6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 2.2)
+  bundler (~> 1.6)
+  generator_spec (~> 0.9)
+  rails (~> 5.2.0)
+  rake (~> 10.4)
+  rspec (~> 3.8)
+  rubocop (~> 0.60)
+  setting_accessors!
+  sqlite3 (~> 1.3)
+  with_model (~> 2.1)
+
+BUNDLED WITH
+   1.17.1

data/lib/generators/setting_accessors/install_generator.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module SettingAccessors
   module Generators
     class InstallGenerator < Rails::Generators::Base
       include Rails::Generators::Migration
 
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path('templates', __dir__)
 
-      argument :model_name, :type => :string, :default => 'Setting'
+      argument :model_name, type: :string, default: 'Setting'
 
-      def self.next_migration_number(path)
+      def self.next_migration_number(_nbr)
         if @prev_migration_nr
           @prev_migration_nr += 1
         else
@@ -22,12 +24,12 @@ module SettingAccessors
         template 'model.rb.erb', "app/models/#{model_name.classify.underscore}.rb"
         migration_template 'migration.rb.erb', "db/migrate/create_#{model_name.classify.underscore.pluralize}.rb"
 
-        initializer 'setting_accessors.rb', <<INIT
-#The model your application is using for settings.
-#If you created it using the SettingAccessors generator, the
-#model name below should already be correct.
-SettingAccessors.setting_class = #{model_name}
-INIT
+        initializer 'setting_accessors.rb', <<~EOS
+          # The model your application is using for settings.
+          # If you created it using the SettingAccessors generator, the
+          # model name below should already be correct.
+          SettingAccessors.setting_class = #{model_name}
+        EOS
       end
     end
   end

data/lib/generators/setting_accessors/templates/model.rb.erb

@@ -20,28 +20,4 @@ class <%= model_name.camelize %> < ActiveRecord::Base
   belongs_to :assignable, :polymorphic => true
 
   include SettingAccessors::SettingScaffold
-
-  #
-  # Makes accessing settings a little easier.
-  # Examples:
-  #
-  #   #Loading **the value** of a global setting named "my_setting"
-  #   Setting.my_setting
-  #
-  #   #Setting **the value** of a global setting named "my_setting"
-  #   Setting.my_setting = [1,2,3,4,5]
-  #
-  #   #Loading **the value** of an assigned setting named "cool_setting"
-  #   #+some_cool_user+ is here an instance of ActiveRecord::Base
-  #   Setting.cool_setting(some_cool_user)
-  #
-  def self.method_missing(method, *args)
-    super(method, *args) if args.size > 1
-    method_name = method.to_s
-    if method_name.last == '='
-      self.create_or_update(method_name[0..method_name.length-2], args.first, nil, true)
-    else
-      self.get(method_name, args.first)
-    end
-  end
 end

data/lib/setting_accessors.rb

@@ -1,11 +1,20 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'active_model/validations'
+
 require 'setting_accessors/version'
-require 'setting_accessors/accessor'
-require 'setting_accessors/converter'
+require 'setting_accessors/helpers'
+require 'setting_accessors/accessor_generator'
+require 'setting_accessors/converters/base'
+require 'setting_accessors/converters/boolean_converter'
+require 'setting_accessors/converters/integer_converter'
+require 'setting_accessors/converters/string_converter'
+require 'setting_accessors/converters/polymorphic_converter'
 require 'setting_accessors/integration'
-require 'setting_accessors/integration_validator'
 require 'setting_accessors/internal'
 require 'setting_accessors/setting_scaffold'
-require 'setting_accessors/validator'
+require 'setting_accessors/setting_set'
 
 ActiveRecord::Base.class_eval do
   include SettingAccessors::Integration
@@ -13,7 +22,7 @@ end
 
 module SettingAccessors
   def self.setting_class
-    self.setting_class_name.constantize
+    setting_class_name.constantize
   end
 
   def self.setting_class=(klass)

data/lib/setting_accessors/accessor_generator.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+#
+# This class handles creating everything necessary for a new setting_accessor
+# and the actual method assignment in the calling class.
+#
+module SettingAccessors
+  class AccessorGenerator
+    attr_reader :setting_name
+    attr_reader :options
+
+    def initialize(setting_name, **options)
+      @setting_name = setting_name
+      @options = options
+    end
+
+    def assign_setting!(klass)
+      SettingAccessors::Internal.set_class_setting(klass, setting_name, options)
+      define_getters(klass)
+      define_setter(klass)
+      define_active_record_helpers(klass)
+    end
+
+    private
+
+    def define_getters(klass, outer_setting_name = setting_name)
+      setting_type = SettingAccessors::Internal.setting_value_type(setting_name, klass).to_sym
+
+      klass.class_eval do
+        define_method(outer_setting_name) do
+          settings.get_or_default(outer_setting_name)
+        end
+
+        # Getter alias for boolean settings
+        alias_method "#{outer_setting_name}?", outer_setting_name if setting_type == :boolean
+      end
+    end
+
+    def define_setter(klass, outer_setting_name = setting_name)
+      klass.class_eval do
+        define_method("#{outer_setting_name}=") do |new_value|
+          settings[outer_setting_name] = new_value
+        end
+      end
+    end
+
+    def define_active_record_helpers(klass, outer_setting_name = setting_name)
+      klass.class_eval do
+        # NAME_was
+        define_method("#{outer_setting_name}_was") do
+          settings.value_was(outer_setting_name)
+        end
+
+        # NAME_before_type_cast
+        define_method("#{outer_setting_name}_before_type_cast") do
+          settings.value_before_type_cast(outer_setting_name)
+        end
+
+        # NAME_changed?
+        define_method("#{outer_setting_name}_changed?") do
+          settings.value_changed?(outer_setting_name)
+        end
+      end
+    end
+  end
+end

data/lib/setting_accessors/converters/base.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SettingAccessors
+  module Converters
+    class Base
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def convert
+        # ActiveRecord does not convert +nil+ values to the corresponding database type
+        return value if value.nil?
+
+        parse_value
+      end
+
+      def self.parse_value
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/setting_accessors/converters/boolean_converter.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module SettingAccessors
+  module Converters
+    class BooleanConverter < Base
+      def parse_value
+        case value
+        when TrueClass, FalseClass
+          value
+        when String
+          parse_string
+        when Integer
+          parse_integer
+        else
+          parse_other_value
+        end
+      end
+
+      private
+
+      #
+      # Special handler for Rails 4.2, see the following deprecation warning:
+      #
+      # DEPRECATION WARNING: You attempted to assign a value which is not explicitly `true` or `false` (0.0)
+      # to a boolean column. Currently this value casts to `false`.
+      # This will change to match Ruby's semantics, and will cast to `true` in Rails 5.
+      # If you would like to maintain the current behavior, you should explicitly handle
+      # the values you would like cast to `false`.
+      #
+      def parse_other_value
+        Gem.loaded_specs['activerecord'].version >= Gem::Version.create('5.0')
+      end
+
+      def parse_integer
+        return true if value.to_i == 1
+        return false if value.to_i.zero?
+
+        nil
+      end
+
+      def parse_string
+        case value.downcase
+        when 'true', '1' then true
+        when 'false', '0' then false
+        when '' then nil
+        else parse_other_value
+        end
+      end
+    end
+  end
+end

data/lib/setting_accessors/converters/integer_converter.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SettingAccessors
+  module Converters
+    class IntegerConverter < Base
+      def parse_value
+        return parse_boolean if value == true || value == false
+
+        value.to_i
+      rescue NoMethodError
+        nil
+      end
+
+      private
+
+      def parse_boolean
+        value ? 1 : 0
+      end
+    end
+  end
+end