RubyGems - spreeference - Versions diffs - 0.1.0 - Mend

spreeference 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (83) hide show

checksums.yaml +7 -0
data/LICENSE.md +26 -0
data/README.md +233 -0
data/Rakefile +26 -0
data/app/models/spreeference/app_configuration.rb +9 -0
data/app/models/spreeference/application_record.rb +16 -0
data/app/models/spreeference/preference.rb +6 -0
data/config/routes.rb +2 -0
data/db/migrate/20170217094656_create_spreeference_preferences.rb +10 -0
data/lib/generators/spreeference/install_generator.rb +17 -0
data/lib/generators/templates/app_configuration.rb +6 -0
data/lib/generators/templates/spreeference.rb +12 -0
data/lib/spreeference.rb +16 -0
data/lib/spreeference/configuration.rb +48 -0
data/lib/spreeference/engine.rb +28 -0
data/lib/spreeference/environment.rb +12 -0
data/lib/spreeference/environment_extension.rb +23 -0
data/lib/spreeference/preferable.rb +103 -0
data/lib/spreeference/preferable_methods.rb +52 -0
data/lib/spreeference/scoped_store.rb +34 -0
data/lib/spreeference/store.rb +93 -0
data/lib/spreeference/version.rb +3 -0
data/lib/tasks/spreeference_tasks.rake +4 -0
data/spec/dummy/Rakefile +6 -0
data/spec/dummy/app/assets/config/manifest.js +3 -0
data/spec/dummy/app/assets/javascripts/application.js +13 -0
data/spec/dummy/app/assets/stylesheets/application.css +15 -0
data/spec/dummy/app/channels/application_cable/channel.rb +4 -0
data/spec/dummy/app/channels/application_cable/connection.rb +4 -0
data/spec/dummy/app/controllers/application_controller.rb +3 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/jobs/application_job.rb +2 -0
data/spec/dummy/app/models/app_configuration.rb +6 -0
data/spec/dummy/app/models/application_record.rb +3 -0
data/spec/dummy/app/views/layouts/application.html.erb +13 -0
data/spec/dummy/bin/bundle +3 -0
data/spec/dummy/bin/rails +4 -0
data/spec/dummy/bin/rake +4 -0
data/spec/dummy/bin/setup +34 -0
data/spec/dummy/bin/update +29 -0
data/spec/dummy/config.ru +5 -0
data/spec/dummy/config/application.rb +23 -0
data/spec/dummy/config/boot.rb +5 -0
data/spec/dummy/config/cable.yml +9 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +42 -0
data/spec/dummy/config/environments/production.rb +73 -0
data/spec/dummy/config/environments/test.rb +36 -0
data/spec/dummy/config/initializers/application_controller_renderer.rb +6 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/cookies_serializer.rb +5 -0
data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/spec/dummy/config/initializers/inflections.rb +16 -0
data/spec/dummy/config/initializers/mime_types.rb +4 -0
data/spec/dummy/config/initializers/new_framework_defaults.rb +24 -0
data/spec/dummy/config/initializers/session_store.rb +3 -0
data/spec/dummy/config/initializers/spreeference.rb +13 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +23 -0
data/spec/dummy/config/puma.rb +47 -0
data/spec/dummy/config/routes.rb +3 -0
data/spec/dummy/config/secrets.yml +22 -0
data/spec/dummy/config/spring.rb +6 -0
data/spec/dummy/db/development.sqlite3 +0 -0
data/spec/dummy/db/schema.rb +23 -0
data/spec/dummy/db/test.sqlite3 +0 -0
data/spec/dummy/log/development.log +69 -0
data/spec/dummy/log/test.log +1995 -0
data/spec/dummy/public/404.html +67 -0
data/spec/dummy/public/422.html +67 -0
data/spec/dummy/public/500.html +66 -0
data/spec/dummy/public/apple-touch-icon-precomposed.png +0 -0
data/spec/dummy/public/apple-touch-icon.png +0 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/lib/spreeference/configuration_spec.rb +27 -0
data/spec/lib/spreeference/preferable_spec.rb +344 -0
data/spec/lib/spreeference/scoped_store_spec.rb +58 -0
data/spec/lib/spreeference/store_spec.rb +46 -0
data/spec/models/spreeference/preference_spec.rb +80 -0
data/spec/rails_helper.rb +31 -0
data/spec/spec_helper.rb +19 -0
metadata +227 -0

data/spec/dummy/public/404.html ADDED Viewed

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <div>
+      <h1>The page you were looking for doesn't exist.</h1>
+      <p>You may have mistyped the address or the page may have moved.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html ADDED Viewed

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <div>
+      <h1>The change you wanted was rejected.</h1>
+      <p>Maybe you tried to change something you didn't have access to.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html ADDED Viewed

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <div>
+      <h1>We're sorry, but something went wrong.</h1>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/apple-touch-icon-precomposed.png ADDED Viewed

File without changes

data/spec/dummy/public/apple-touch-icon.png ADDED Viewed

File without changes

data/spec/dummy/public/favicon.ico ADDED Viewed

File without changes

data/spec/lib/spreeference/configuration_spec.rb ADDED Viewed

@@ -0,0 +1,27 @@
+module Spreeference
+  describe Spreeference::Configuration, type: :model do
+    before :all do
+      class AppConfig < Spreeference::Configuration
+        preference :color, :string, default: :blue
+      end
+      @config = AppConfig.new
+    end
+    it "has named methods to access preferences" do
+      @config.color = 'orange'
+      expect(@config.color).to eq 'orange'
+    end
+    it "uses [ ] to access preferences" do
+      @config[:color] = 'red'
+      expect(@config[:color]).to eq 'red'
+    end
+    it "uses set/get to access preferences" do
+      @config.set :color, 'green'
+      expect(@config.get(:color)).to eq 'green'
+    end
+  end
+end

data/spec/lib/spreeference/preferable_spec.rb ADDED Viewed

@@ -0,0 +1,344 @@
+module Spreeference
+  describe Spreeference::Preferable, type: :model do
+    before :all do
+      class A
+        include Spreeference::Preferable
+        attr_reader :id
+        def initialize
+          @id = rand(999)
+        end
+        def preferences
+          @preferences ||= default_preferences
+        end
+        preference :color, :string, default: 'green'
+      end
+      class B < A
+        preference :flavor, :string
+      end
+    end
+    before :each do
+      @a = A.new
+      allow(@a).to receive_messages(persisted?: true)
+      @b = B.new
+      allow(@b).to receive_messages(persisted?: true)
+      # ensure we're persisting as that is the default
+      #
+      store = Spreeference::Store.instance
+      store.persistence = true
+    end
+    describe "preference definitions" do
+      it "parent should not see child definitions" do
+        expect(@a.has_preference?(:color)).to be true
+        expect(@a.has_preference?(:flavor)).not_to be true
+      end
+      it "child should have parent and own definitions" do
+        expect(@b.has_preference?(:color)).to be true
+        expect(@b.has_preference?(:flavor)).to be true
+      end
+      it "instances have defaults" do
+        expect(@a.preferred_color).to eq 'green'
+        expect(@b.preferred_color).to eq 'green'
+        expect(@b.preferred_flavor).to be_nil
+      end
+      it "can be asked if it has a preference definition" do
+        expect(@a.has_preference?(:color)).to be true
+        expect(@a.has_preference?(:bad)).to be false
+      end
+      it "can be asked and raises" do
+        expect {
+          @a.has_preference! :flavor
+        }.to raise_error(NoMethodError, "flavor preference not defined")
+      end
+      it "has a type" do
+        expect(@a.preferred_color_type).to eq :string
+        expect(@a.preference_type(:color)).to eq :string
+      end
+      it "has a default" do
+        expect(@a.preferred_color_default).to eq 'green'
+        expect(@a.preference_default(:color)).to eq 'green'
+      end
+      it "raises if not defined" do
+        expect {
+          @a.get_preference :flavor
+        }.to raise_error(NoMethodError, "flavor preference not defined")
+      end
+    end
+    describe "preference access" do
+      it "handles ghost methods for preferences" do
+        @a.preferred_color = 'blue'
+        expect(@a.preferred_color).to eq 'blue'
+      end
+      it "parent and child instances have their own prefs" do
+        @a.preferred_color = 'red'
+        @b.preferred_color = 'blue'
+        expect(@a.preferred_color).to eq 'red'
+        expect(@b.preferred_color).to eq 'blue'
+      end
+      it "raises when preference not defined" do
+        expect {
+          @a.set_preference(:bad, :bone)
+        }.to raise_exception(NoMethodError, "bad preference not defined")
+      end
+      it "builds a hash of preferences" do
+        @b.preferred_flavor = :strawberry
+        expect(@b.preferences[:flavor]).to eq 'strawberry'
+        expect(@b.preferences[:color]).to eq 'green' #default from A
+      end
+      it "builds a hash of preference defaults" do
+        expect(@b.default_preferences).to eq({
+          flavor: nil,
+          color: 'green'
+        })
+      end
+      context "converts integer preferences to integer values" do
+        before do
+          A.preference :is_integer, :integer
+        end
+        it "with strings" do
+          @a.set_preference(:is_integer, '3')
+          expect(@a.preferences[:is_integer]).to eq(3)
+          @a.set_preference(:is_integer, '')
+          expect(@a.preferences[:is_integer]).to eq(0)
+        end
+      end
+      context "converts decimal preferences to BigDecimal values" do
+        before do
+          A.preference :if_decimal, :decimal
+        end
+        it "returns a BigDecimal" do
+          @a.set_preference(:if_decimal, 3.3)
+          expect(@a.preferences[:if_decimal].class).to eq(BigDecimal)
+        end
+        it "with strings" do
+          @a.set_preference(:if_decimal, '3.3')
+          expect(@a.preferences[:if_decimal]).to eq(3.3)
+          @a.set_preference(:if_decimal, '')
+          expect(@a.preferences[:if_decimal]).to eq(0.0)
+        end
+      end
+      context "converts boolean preferences to boolean values" do
+        before do
+          A.preference :is_boolean, :boolean, default: true
+        end
+        it "with strings" do
+          @a.set_preference(:is_boolean, '0')
+          expect(@a.preferences[:is_boolean]).to be false
+          @a.set_preference(:is_boolean, 'f')
+          expect(@a.preferences[:is_boolean]).to be false
+          @a.set_preference(:is_boolean, 't')
+          expect(@a.preferences[:is_boolean]).to be true
+        end
+        it "with integers" do
+          @a.set_preference(:is_boolean, 0)
+          expect(@a.preferences[:is_boolean]).to be false
+          @a.set_preference(:is_boolean, 1)
+          expect(@a.preferences[:is_boolean]).to be true
+        end
+        it "with an empty string" do
+          @a.set_preference(:is_boolean, '')
+          expect(@a.preferences[:is_boolean]).to be false
+        end
+        it "with an empty hash" do
+          @a.set_preference(:is_boolean, [])
+          expect(@a.preferences[:is_boolean]).to be false
+        end
+      end
+      context "converts array preferences to array values" do
+        before do
+          A.preference :is_array, :array, default: []
+        end
+        it "with arrays" do
+          @a.set_preference(:is_array, [])
+          expect(@a.preferences[:is_array]).to be_is_a(Array)
+        end
+        it "with string" do
+          @a.set_preference(:is_array, "string")
+          expect(@a.preferences[:is_array]).to be_is_a(Array)
+        end
+        it "with hash" do
+          @a.set_preference(:is_array, {})
+          expect(@a.preferences[:is_array]).to be_is_a(Array)
+        end
+      end
+      context "converts hash preferences to hash values" do
+        before do
+          A.preference :is_hash, :hash, default: {}
+        end
+        it "with hash" do
+          @a.set_preference(:is_hash, {})
+          expect(@a.preferences[:is_hash]).to be_is_a(Hash)
+        end
+        it "with hash and keys are integers" do
+          @a.set_preference(:is_hash, {1 => 2, 3 => 4})
+          expect(@a.preferences[:is_hash]).to eql({1 => 2, 3 => 4})
+        end
+        it "with string" do
+          @a.set_preference(:is_hash, "{\"0\"=>{\"answer\"=>\"1\", \"value\"=>\"No\"}}")
+          expect(@a.preferences[:is_hash]).to be_is_a(Hash)
+        end
+        it "with boolean" do
+          @a.set_preference(:is_hash, false)
+          expect(@a.preferences[:is_hash]).to be_is_a(Hash)
+          @a.set_preference(:is_hash, true)
+          expect(@a.preferences[:is_hash]).to be_is_a(Hash)
+        end
+        it "with simple array" do
+          @a.set_preference(:is_hash, ["key", "value", "another key", "another value"])
+          expect(@a.preferences[:is_hash]).to be_is_a(Hash)
+          expect(@a.preferences[:is_hash]["key"]).to eq("value")
+          expect(@a.preferences[:is_hash]["another key"]).to eq("another value")
+        end
+        it "with a nested array" do
+          @a.set_preference(:is_hash, [["key", "value"], ["another key", "another value"]])
+          expect(@a.preferences[:is_hash]).to be_is_a(Hash)
+          expect(@a.preferences[:is_hash]["key"]).to eq("value")
+          expect(@a.preferences[:is_hash]["another key"]).to eq("another value")
+        end
+        it "with single array" do
+          expect { @a.set_preference(:is_hash, ["key"]) }.to raise_error(ArgumentError)
+        end
+      end
+      context "converts any preferences to any values" do
+        before do
+          A.preference :product_ids, :any, default: []
+          A.preference :product_attributes, :any, default: {}
+        end
+        it "with array" do
+          expect(@a.preferences[:product_ids]).to eq([])
+          @a.set_preference(:product_ids, [1, 2])
+          expect(@a.preferences[:product_ids]).to eq([1, 2])
+        end
+        it "with hash" do
+          expect(@a.preferences[:product_attributes]).to eq({})
+          @a.set_preference(:product_attributes, {id: 1, name: 2})
+          expect(@a.preferences[:product_attributes]).to eq({id: 1, name: 2})
+        end
+      end
+    end
+    describe "persisted preferables" do
+      before(:all) do
+        class CreatePrefTest < ActiveRecord::Migration[4.2]
+          def self.up
+            create_table :pref_tests do |t|
+              t.string :col
+              t.text :preferences
+            end
+          end
+          def self.down
+            drop_table :pref_tests
+          end
+        end
+        @migration_verbosity = ActiveRecord::Migration.verbose
+        ActiveRecord::Migration.verbose = false
+        CreatePrefTest.migrate(:up)
+        class PrefTest < Spreeference::ApplicationRecord
+          preference :pref_test_pref, :string, default: 'abc'
+          preference :pref_test_any, :any, default: []
+        end
+      end
+      after(:all) do
+        CreatePrefTest.migrate(:down)
+        ActiveRecord::Migration.verbose = @migration_verbosity
+      end
+      before(:each) do
+        # load PrefTest table
+        PrefTest.first
+        @pt = PrefTest.create
+      end
+      describe "pending preferences for new activerecord objects" do
+        it "saves preferences after record is saved" do
+          pr = PrefTest.new
+          pr.set_preference(:pref_test_pref, 'XXX')
+          expect(pr.get_preference(:pref_test_pref)).to eq('XXX')
+          pr.save!
+          expect(pr.get_preference(:pref_test_pref)).to eq('XXX')
+        end
+        it "saves preferences for serialized object" do
+          pr = PrefTest.new
+          pr.set_preference(:pref_test_any, [1, 2])
+          expect(pr.get_preference(:pref_test_any)).to eq([1, 2])
+          pr.save!
+          expect(pr.get_preference(:pref_test_any)).to eq([1, 2])
+        end
+      end
+      it "clear preferences" do
+        @pt.set_preference(:pref_test_pref, 'xyz')
+        expect(@pt.preferred_pref_test_pref).to eq('xyz')
+        @pt.clear_preferences
+        expect(@pt.preferred_pref_test_pref).to eq('abc')
+      end
+      it "clear preferences when record is deleted" do
+        @pt.save!
+        @pt.preferred_pref_test_pref = 'lmn'
+        @pt.save!
+        @pt.destroy
+        @pt1 = PrefTest.new(col: 'aaaa')
+        @pt1.id = @pt.id
+        @pt1.save!
+        expect(@pt1.get_preference(:pref_test_pref)).to eq('abc')
+      end
+    end
+  end
+end