spreeference 0.1.0

data/spec/lib/spreeference/scoped_store_spec.rb

@@ -0,0 +1,58 @@
+module Spreeference
+  describe Spreeference::ScopedStore, type: :model do
+    let(:scoped_store){ described_class.new(prefix, suffix) }
+    subject{ scoped_store }
+    let(:prefix){ nil }
+    let(:suffix){ nil }
+
+    describe '#store' do
+      subject{ scoped_store.store }
+      it{ is_expected.to be Spreeference::Store.instance }
+    end
+
+    context 'stubbed store' do
+      let(:store){ double(:store) }
+      before do
+        allow(scoped_store).to receive(:store).and_return(store)
+      end
+
+      context "with a prefix" do
+        let(:prefix){ 'my_class' }
+
+        it "can fetch" do
+          expect(store).to receive(:fetch).with('my_class/attr')
+          scoped_store.fetch('attr'){ 'default' }
+        end
+
+        it "can assign" do
+          expect(store).to receive(:[]=).with('my_class/attr', 'val')
+          scoped_store['attr'] = 'val'
+        end
+
+        it "can delete" do
+          expect(store).to receive(:delete).with('my_class/attr')
+          scoped_store.delete('attr')
+        end
+
+        context "and suffix" do
+          let(:suffix){ 123 }
+
+          it "can fetch" do
+            expect(store).to receive(:fetch).with('my_class/attr/123')
+            scoped_store.fetch('attr'){ 'default' }
+          end
+
+          it "can assign" do
+            expect(store).to receive(:[]=).with('my_class/attr/123', 'val')
+            scoped_store['attr'] = 'val'
+          end
+
+          it "can delete" do
+            expect(store).to receive(:delete).with('my_class/attr/123')
+            scoped_store.delete('attr')
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/spreeference/store_spec.rb

@@ -0,0 +1,46 @@
+module Spreeference
+  describe Spreeference::Store, type: :model do
+    before :each do
+      @store = Spreeference::StoreInstance.new
+    end
+
+    it "sets and gets a key" do
+      @store.set :test, 1
+      expect(@store.exist?(:test)).to be true
+      expect(@store.get(:test)).to eq 1
+    end
+
+    it "can set and get false values when cache return nil" do
+      @store.set :test, false
+      expect(@store.get(:test)).to be false
+    end
+
+    it "will return db value when cache is emtpy and cache the db value" do
+      preference = Spreeference::Preference.where(key: 'test').first_or_initialize
+      preference.value = '123'
+      preference.save
+
+      Rails.cache.clear
+      expect(@store.get(:test)).to eq '123'
+      expect(Rails.cache.read(:test)).to eq '123'
+    end
+
+    it "should return and cache fallback value when supplied" do
+      Rails.cache.clear
+      expect(@store.get(:test){ false }).to be false
+      expect(Rails.cache.read(:test)).to be false
+    end
+
+    it "should return but not cache fallback value when persistence is disabled" do
+      Rails.cache.clear
+      allow(@store).to receive_messages(should_persist?: false)
+      expect(@store.get(:test){ true }).to be true
+      expect(Rails.cache.exist?(:test)).to be false
+    end
+
+    it "should return nil when key can't be found and fallback value is not supplied" do
+      expect(@store.get(:random_key){ nil }).to be_nil
+    end
+
+  end
+end

data/spec/models/spreeference/preference_spec.rb

@@ -0,0 +1,80 @@
+module Spreeference
+  describe Spreeference::Preference, type: :model do
+
+    it "should require a key" do
+      @preference = Spreeference::Preference.new
+      @preference.key = :test
+      @preference.value = true
+      expect(@preference).to be_valid
+    end
+
+    describe "type coversion for values" do
+      def round_trip_preference(key, value)
+        p = Spreeference::Preference.new
+        p.value = value
+        p.key = key
+        p.save
+
+        Spreeference::Preference.find_by_key(key)
+      end
+
+      it ":boolean" do
+        value = true
+        key = "boolean_key"
+        pref = round_trip_preference(key, value)
+        expect(pref.value).to eq value
+      end
+
+      it "false :boolean" do
+        value = false
+        key = "boolean_key"
+        pref = round_trip_preference(key, value)
+        expect(pref.value).to eq value
+      end
+
+      it ":integer" do
+        value = 10
+        key = "integer_key"
+        pref = round_trip_preference(key, value)
+        expect(pref.value).to eq value
+      end
+
+      it ":decimal" do
+        value = 1.5
+        key = "decimal_key"
+        pref = round_trip_preference(key, value)
+        expect(pref.value).to eq value
+      end
+
+      it ":string" do
+        value = "This is a string"
+        key = "string_key"
+        pref = round_trip_preference(key, value)
+        expect(pref.value).to eq value
+      end
+
+      it ":text" do
+        value = "This is a string stored as text"
+        key = "text_key"
+        pref = round_trip_preference(key, value)
+        expect(pref.value).to eq value
+      end
+
+      it ":password" do
+        value = "This is a password"
+        key = "password_key"
+        pref = round_trip_preference(key, value)
+        expect(pref.value).to eq value
+      end
+
+      it ":any" do
+        value = [1, 2]
+        key = "any_key"
+        pref = round_trip_preference(key, value)
+        expect(pref.value).to eq value
+      end
+
+    end
+  end
+
+end

data/spec/rails_helper.rb

@@ -0,0 +1,31 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../dummy/config/environment', __FILE__)
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require 'spec_helper'
+require 'rspec/rails'
+require 'factory_girl_rails'
+require 'capybara/rspec'
+require 'rspec/active_model/mocks'
+
+
+ENGINE_RAILS_ROOT = File.join(File.dirname(__FILE__), '../')
+
+Dir[File.join(ENGINE_RAILS_ROOT, "spec/factories/**/*.rb")].each {|f| require f }
+Dir[File.join(ENGINE_RAILS_ROOT, "spec/support/**/*.rb")].each {|f| require f }
+Dir[File.join(ENGINE_RAILS_ROOT, "spec/concerns/**/*.rb")].each {|f| require f }
+
+
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+  config.mock_with :rspec
+  config.use_transactional_fixtures = true
+  config.infer_spec_type_from_file_location!
+  config.filter_rails_from_backtrace!
+  config.before :each do
+    Rails.cache.clear
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.start do 
+  minimum_coverage(75.0)
+end
+
+Coveralls.wear!
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: spreeference
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hugomarquez
+- Spree Commerce
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: application-wide and per model cached and persisted preferences
+email:
+- hugomarquez.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- app/models/spreeference/app_configuration.rb
+- app/models/spreeference/application_record.rb
+- app/models/spreeference/preference.rb
+- config/routes.rb
+- db/migrate/20170217094656_create_spreeference_preferences.rb
+- lib/generators/spreeference/install_generator.rb
+- lib/generators/templates/app_configuration.rb
+- lib/generators/templates/spreeference.rb
+- lib/spreeference.rb
+- lib/spreeference/configuration.rb
+- lib/spreeference/engine.rb
+- lib/spreeference/environment.rb
+- lib/spreeference/environment_extension.rb
+- lib/spreeference/preferable.rb
+- lib/spreeference/preferable_methods.rb
+- lib/spreeference/scoped_store.rb
+- lib/spreeference/store.rb
+- lib/spreeference/version.rb
+- lib/tasks/spreeference_tasks.rake
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/channels/application_cable/channel.rb
+- spec/dummy/app/channels/application_cable/connection.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/jobs/application_job.rb
+- spec/dummy/app/models/app_configuration.rb
+- spec/dummy/app/models/application_record.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/bin/update
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/cable.yml
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/application_controller_renderer.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/new_framework_defaults.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/spreeference.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/puma.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
+- spec/dummy/config/spring.rb
+- spec/dummy/db/development.sqlite3
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/apple-touch-icon-precomposed.png
+- spec/dummy/public/apple-touch-icon.png
+- spec/dummy/public/favicon.ico
+- spec/lib/spreeference/configuration_spec.rb
+- spec/lib/spreeference/preferable_spec.rb
+- spec/lib/spreeference/scoped_store_spec.rb
+- spec/lib/spreeference/store_spec.rb
+- spec/models/spreeference/preference_spec.rb
+- spec/rails_helper.rb
+- spec/spec_helper.rb
+homepage: https://github.com/hugomarquez/spreeference
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: application-wide and per model cached and persisted preferences
+test_files:
+- spec/dummy/app/assets/config/manifest.js
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/channels/application_cable/channel.rb
+- spec/dummy/app/channels/application_cable/connection.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/jobs/application_job.rb
+- spec/dummy/app/models/app_configuration.rb
+- spec/dummy/app/models/application_record.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/bin/update
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/cable.yml
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/application_controller_renderer.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/new_framework_defaults.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/spreeference.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/puma.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
+- spec/dummy/config/spring.rb
+- spec/dummy/config.ru
+- spec/dummy/db/development.sqlite3
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/apple-touch-icon-precomposed.png
+- spec/dummy/public/apple-touch-icon.png
+- spec/dummy/public/favicon.ico
+- spec/dummy/Rakefile
+- spec/lib/spreeference/configuration_spec.rb
+- spec/lib/spreeference/preferable_spec.rb
+- spec/lib/spreeference/scoped_store_spec.rb
+- spec/lib/spreeference/store_spec.rb
+- spec/models/spreeference/preference_spec.rb
+- spec/rails_helper.rb
+- spec/spec_helper.rb