spreeference 0.1.0

data/lib/spreeference/engine.rb

@@ -0,0 +1,28 @@
+module Spreeference
+  class Engine < ::Rails::Engine
+    
+    isolate_namespace Spreeference
+
+    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
+
+    initializer 'spreeference.environment', before: :load_config_initializers do |app|
+      app.config.spreeference = Spreeference::Environment.new
+      Spreeference::Config = app.config.spreeference.preferences
+    end
+
+    # Adds migrations to host application
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match root.to_s
+        config.paths["db/migrate"].expanded.each do |path|
+          app.config.paths["db/migrate"] << path
+        end
+      end
+    end
+    
+  end
+end

data/lib/spreeference/environment.rb

@@ -0,0 +1,12 @@
+module Spreeference
+  class Environment
+    include EnvironmentExtension
+
+    attr_accessor :preferences
+
+    def initialize
+      @preferences = Spreeference::AppConfiguration.new
+    end
+
+  end
+end

data/lib/spreeference/environment_extension.rb

@@ -0,0 +1,23 @@
+module Spreeference
+  module EnvironmentExtension
+    extend ActiveSupport::Concern
+    
+    def add_class(name)
+      self.instance_variable_set "@#{name}", Set.new
+      create_method( "#{name}=".to_sym ) { |val|
+        instance_variable_set( "@" + name, val)
+      }
+
+      create_method(name.to_sym) do
+        instance_variable_get( "@" + name )
+      end
+    end
+
+    private
+    
+    def create_method(name, &block)
+      self.class.send(:define_method, name, &block)
+    end
+
+  end
+end

data/lib/spreeference/preferable.rb

@@ -0,0 +1,103 @@
+module Spreeference
+  module Preferable
+    extend ActiveSupport::Concern
+
+    included do
+      extend Spreeference::PreferableMethods
+    end
+
+    def get_preference(name)
+      has_preference! name
+      send self.class.preference_getter_method(name)
+    end
+
+    def set_preference(name, value)
+      has_preference! name
+      send self.class.preference_setter_method(name), value
+    end
+
+    def preference_type(name)
+      has_preference! name
+      send self.class.preference_type_getter_method(name)
+    end
+
+    def preference_default(name)
+      has_preference! name
+      send self.class.preference_default_getter_method(name)
+    end
+
+    def has_preference!(name)
+      raise NoMethodError.new "#{name} preference not defined" unless has_preference? name
+    end
+
+    def has_preference?(name)
+      respond_to? self.class.preference_getter_method(name)
+    end
+
+    def defined_preferences
+      methods.grep(/\Apreferred_.*=\Z/).map do |pref_method|
+        pref_method.to_s.gsub(/\Apreferred_|=\Z/, '').to_sym
+      end
+    end
+
+    def default_preferences
+      Hash[
+        defined_preferences.map do |preference|
+          [preference, preference_default(preference)]
+        end
+      ]
+    end
+
+    def clear_preferences
+      preferences.keys.each {|pref| preferences.delete pref}
+    end
+
+    private
+
+    def convert_preference_value(value, type)
+      case type
+      when :string, :text
+        value.to_s
+      when :password
+        value.to_s
+      when :decimal
+        BigDecimal.new(value.to_s)
+      when :integer
+        value.to_i
+      when :boolean
+        if value.is_a?(FalseClass) ||
+           value.nil? ||
+           value == 0 ||
+           value =~ /^(f|false|0)$/i ||
+           (value.respond_to? :empty? and value.empty?)
+           false
+        else
+           true
+        end
+      when :array
+        value.is_a?(Array) ? value : Array.wrap(value)
+      when :hash
+        case value.class.to_s
+        when "Hash"
+          value
+        when "String"
+          # only works with hashes whose keys are strings
+          JSON.parse value.gsub('=>', ':')
+        when "Array"
+          begin
+            value.try(:to_h)
+          rescue TypeError
+            Hash[*value]
+          rescue ArgumentError
+            raise 'An even count is required when passing an array to be converted to a hash'
+          end
+        else
+          value.class.ancestors.include?(Hash) ? value : {}
+        end
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/spreeference/preferable_methods.rb

@@ -0,0 +1,52 @@
+module Spreeference
+  module PreferableMethods
+
+    def preference(name, type, *args)
+      options = args.extract_options!
+      options.assert_valid_keys(:default)
+      default = options[:default]
+      default = ->{ options[:default] } unless default.is_a?(Proc)
+
+      # cache_key will be nil for new objects, then if we check if there
+      # is a pending preference before going to default
+      define_method preference_getter_method(name) do
+        preferences.fetch(name) do
+          default.call
+        end
+      end
+
+      define_method preference_setter_method(name) do |value|
+        value = convert_preference_value(value, type)
+        preferences[name] = value
+
+        # If this is an activerecord object, we need to inform
+        # ActiveRecord::Dirty that this value has changed, since this is an
+        # in-place update to the preferences hash.
+        preferences_will_change! if respond_to?(:preferences_will_change!)
+      end
+
+      define_method preference_default_getter_method(name), &default
+
+      define_method preference_type_getter_method(name) do
+        type
+      end
+    end
+
+    def preference_getter_method(name)
+      "preferred_#{name}".to_sym
+    end
+
+    def preference_setter_method(name)
+       "preferred_#{name}=".to_sym
+    end
+
+    def preference_default_getter_method(name)
+      "preferred_#{name}_default".to_sym
+    end
+
+    def preference_type_getter_method(name)
+      "preferred_#{name}_type".to_sym
+    end
+    
+  end
+end

data/lib/spreeference/scoped_store.rb

@@ -0,0 +1,34 @@
+module Spreeference
+  class ScopedStore
+    def initialize prefix, suffix=nil
+      @prefix = prefix
+      @suffix = suffix
+    end
+
+    def store
+      Spreeference::Store.instance
+    end
+
+    def fetch key, &block
+      store.fetch(key_for(key), &block)
+    end
+
+    def []= key, value
+      store[key_for(key)] = value
+    end
+
+    def delete key
+      store.delete(key_for(key))
+    end
+
+    private
+    def key_for key
+      [rails_cache_id, @prefix, key, @suffix].compact.join('/')
+    end
+
+    def rails_cache_id
+      ENV['RAILS_CACHE_ID']
+    end
+
+  end
+end

data/lib/spreeference/store.rb

@@ -0,0 +1,93 @@
+require 'singleton'
+
+module Spreeference
+  class StoreInstance
+    attr_accessor :persistence
+
+    def initialize
+      @cache = Rails.cache
+      @persistence = true
+    end
+
+    def set(key, value)
+      @cache.write(key, value)
+      persist(key, value)
+    end
+    
+    alias_method :[]=, :set
+
+    def exist?(key)
+      @cache.exist?(key) ||
+      should_persist? && Spreeference::Preference.where(key: key).exists?
+    end
+
+    def get(key)
+      # return the retrieved value, if it's in the cache
+      # use unless nil? incase the value is actually boolean false
+      #
+      unless (val = @cache.read(key)).nil?
+        return val
+      end
+
+      if should_persist?
+        # If it's not in the cache, maybe it's in the database, but
+        # has been cleared from the cache
+
+        # does it exist in the database?
+        if preference = Spreeference::Preference.find_by_key(key)
+          # it does exist
+          val = preference.value
+        else
+          # use the fallback value
+          val = yield
+        end
+
+        # Cache either the value from the db or the fallback value.
+        # This avoids hitting the db with subsequent queries.
+        @cache.write(key, val)
+
+        return val
+      else
+        yield
+      end
+    end
+    
+    alias_method :fetch, :get
+
+    def delete(key)
+      @cache.delete(key)
+      destroy(key)
+    end
+
+    def clear_cache
+      @cache.clear
+    end
+
+    private
+
+    def persist(cache_key, value)
+      return unless should_persist?
+
+      preference = Spreeference::Preference.where(key: cache_key).first_or_initialize
+      preference.value = value
+      preference.save
+    end
+
+    def destroy(cache_key)
+      return unless should_persist?
+
+      preference = Spreeference::Preference.find_by_key(cache_key)
+      preference.destroy if preference
+    end
+
+    def should_persist?
+      @persistence and Spreeference::Preference.table_exists?
+    end
+
+  end
+
+  class Store < StoreInstance
+    include Singleton
+  end
+
+end

data/lib/spreeference/version.rb

@@ -0,0 +1,3 @@
+module Spreeference
+  VERSION = '0.1.0'
+end

data/lib/tasks/spreeference_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :spreeference do
+#   # Task goes here
+# end

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_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+
+//= link_tree ../images
+//= link_directory ../stylesheets .css

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/models/app_configuration.rb

@@ -0,0 +1,6 @@
+class AppConfiguration < Spreeference::Configuration
+  # preference :checkbox, :boolean,  default: true
+  # preference :input, :string, default:'changeme'
+  # preference :number, :integer, default: 123
+  # preference :list, :array, default:[]
+end