preferred 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 845a796bc25a6fbbfdca3d033a224e6d5dc0f9d4
+  data.tar.gz: 417e5f78aeab9ae1e551207bf7c1d7cfc46cc07e
+SHA512:
+  metadata.gz: cfce22e8f4fe07323d9f6d67af82dfea84591e19c7e8291cc247899c330d553352dc54f4ec3cb921529c0b71712cf96d0531d08b1e719b95bf60f829b27f3408
+  data.tar.gz: 4d43fdb6179fac9ba952c4d830edb042d8888f9c50c626a0bfed68caac9c2be628c6bcdd2149bbfab067240cd7cc6c18126b840026b157ff59a75ccb892b3287

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,101 @@
+# preferred
+
+preferred provides a simple mechanism defining and storing preferences on a model.
+This becomes powerful when used in conjunction with Single Table Inheritance
+in Rails. Concepts for this gem were initially taken from the Spree open source
+project and ported to use PostgreSQL JSONB columns instead of separate preferences
+table.
+
+# Usage
+
+To install preferred add the following to your Gemfile
+
+```ruby
+gem 'preferred', git: 'https://github.com/nwwatson/preferred.git'
+```
+
+Once in your Gemfile
+
+```shell
+bundle install
+```
+
+# Simple Example
+
+This simple example shows how to use preferred in a Rails model. Default values are optional. Preferred will provides types for string, decimal, integer, boolean, and date. Preferences are prefixed with "preferred_".
+
+Create a model and ensure that it has a JSONB column called preference_hash
+
+```shell
+bin/rails g model example_model preference_hash:jsonb
+```
+
+Define preferences in the model and use
+
+```ruby
+class ExampleModel < ApplicationRecord
+  include Preferred::Preferable
+
+  preference :nickname, :string
+  preference :min_value, :decimal, default: 32.0
+  preference :year, :integer, default: 2018
+  preference :has_example, :boolean, default: true
+  preference :birthday, :date, default: Date.today
+end
+
+example_model = ExampleModel.new
+example_model.has_preference?(:min_value) # returns true
+example_model.preferred_min_value # returns 32.0
+example_model.preferred_min_value = 0 # sets min_value to 0
+example_model.preference_default(:min_value) # returns 32.0
+example_model.preference_type(:min_value) # returns :decimal
+```
+
+# Complex example using Single Table Inheritance
+
+Create base model
+
+```
+bin/rails g model strategy description:string type:string preference_hash:jsonb
+```
+
+## Include Preferable in Strategy model
+
+```ruby
+class Strategy < ApplicationRecord
+  include Preferred::Preferable
+
+  validates_presence_of :description
+
+end
+```
+
+Define a models that extends Strategy
+
+## WithinRange Strategy
+
+```ruby
+class WithinRange < Strategy
+  # The minimum temperature value for the range
+  preference :min, :decimal, default: 28.0
+  # The maximum temperature value for the range
+  preference :max, :decimal, default: 42.0
+
+  def good?(value)
+    (value => preferred_min) and (value <= preferred_max)
+  end
+end
+```
+
+## BelowMaximum Strategy
+
+```ruby
+class BelowMaximum < Strategy
+  # The maximum temperature allowed
+  preference :max, :decimal, default: 160.0
+
+  def good?(value)
+    value < preferred_max
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Preferred'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/preferred.rb

@@ -0,0 +1,7 @@
+require "preferred/railtie"
+require "preferred/preferable_class_methods"
+require "preferred/preferable"
+
+module Preferred
+  # Your code goes here...
+end

data/lib/preferred/preferable.rb

@@ -0,0 +1,84 @@
+module Preferred::Preferable
+  extend ActiveSupport::Concern
+
+  included do
+    extend PreferableClassMethods
+  end
+
+  def get_preference(name)
+    has_preference! name
+    send self.class.preference_getter_method(name)
+  end
+  alias :preferred :get_preference
+  alias :prefers? :get_preference
+
+  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 preference_description(name)
+    has_preference! name
+    send self.class.preference_description_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 preferences
+    prefs = {}
+    methods.grep(/^prefers_.*\?$/).each do |pref_method|
+      prefs[pref_method.to_s.gsub(/prefers_|\?/, '').to_sym] = send(pref_method)
+    end
+    prefs
+  end
+
+  def clear_preferences
+    preference_hash.keys.each {|pref| preference_hash.delete pref} if preference_hash.is_a? Hash
+  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 :date
+      value.is_a?(Date) ? value : Date.parse(value)
+    else
+      value
+    end
+  end
+
+end

data/lib/preferred/preferable_class_methods.rb

@@ -0,0 +1,69 @@
+module Preferred::Preferable
+
+  def preference(name, type, *args)
+    options = args.extract_options!
+    options.assert_valid_keys(:default, :description)
+    default = options[:default]
+    description = options[:description] || name
+
+    # 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
+      if self.preference_hash && preference_hash.key?(name.to_s)
+        convert_preference_value(preference_hash[name.to_s]["value"], preference_hash[name.to_s]["type"])
+      else
+        send self.class.preference_default_getter_method(name)
+      end
+    end
+
+    define_method preference_setter_method(name) do |value|
+      value = convert_preference_value(value, type)
+      self.preference_hash = {} if preference_hash.nil?
+      self.preference_hash[name.to_s] = {
+        value: value,
+        type: type
+      }
+    end
+
+    define_method preference_default_getter_method(name) do
+      default
+    end
+
+    define_method preference_type_getter_method(name) do
+      type
+    end
+
+    define_method preference_description_getter_method(name) do
+      description
+    end
+  end
+
+  def remove_preference(name)
+    remove_method preference_getter_method(name) if method_defined? preference_getter_method(name)
+    remove_method preference_setter_method(name) if method_defined? preference_setter_method(name)
+    remove_method preference_default_getter_method(name) if method_defined? preference_default_getter_method(name)
+    remove_method preference_type_getter_method(name) if method_defined? preference_type_getter_method(name)
+    remove_method preference_description_getter_method(name) if method_defined? preference_description_getter_method(name)
+  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
+
+  def preference_description_getter_method(name)
+    "preferred_#{name}_description".to_sym
+  end
+
+end

data/lib/preferred/railtie.rb

@@ -0,0 +1,4 @@
+module Preferred
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/preferred/version.rb

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

data/lib/tasks/preferred_tasks.rake

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

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: preferred
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicholas W. Watson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.18.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'
+description: Preferred allows you to define preferences on a model and stores them
+  in a jsonb column in PostgreSQL
+email:
+- nicholas.w.watson@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/preferred.rb
+- lib/preferred/preferable.rb
+- lib/preferred/preferable_class_methods.rb
+- lib/preferred/railtie.rb
+- lib/preferred/version.rb
+- lib/tasks/preferred_tasks.rake
+homepage: https://github.com/nwwatson/preferred
+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.2
+signing_key: 
+specification_version: 4
+summary: Preferences on your Rails models stored in a JSONB column in PostgreSQL
+test_files: []