preferencias 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmQyMjVhN2RkOTExNzIyYmE2OGI4YmM4MWI2N2E4Yjg3Yzc1MmJkOQ==
+  data.tar.gz: !binary |-
+    MzcyMjBiNDdlYjFkZmNmODA0MThmODc3OWRkYzkzMDM4OTc0ODFhMg==
+SHA512:
+  metadata.gz: !binary |-
+    Mzk4YTkyNTVkYzBkYzcwZTZhYTU5Y2M3ODI2MWQxMjJmNTc3NGFhZTAwZDJk
+    MWJmZjJkMDQ1MzY3ZWMyZTA0ZTBjZjljMTgxMTY3OGQ3ZjZhZDVmNWU0M2Jh
+    YTk5ODllNDY0MGI0ZjY2YWI5ZDUxMGMyYTdiZDkwOGEyZDRkZmY=
+  data.tar.gz: !binary |-
+    MTNjNzhkOTQ0YTA1YWRjMDMxZGExY2E3NTJjMTlmMTQ0MTY0NzQ5OWNmZjE5
+    MGVlOWNlYWJkZDBiYjJlNmU5ZWE4NjgzOTk0MTViOWE0ZDUyZGI0OWI2N2Jl
+    OWQ0NjNhYTc3OGJjYWUxNDQ4OWEzNzU4YjA1MmI2NTQzN2FhOTc=

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in preferencias.gemspec
+gemspec
+
+gem 'pry', group: :test
+gem 'pry-nav', group: :test

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 David Silva
+
+MIT License
+
+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,47 @@
+# Preferências
+
+[![Build Status](https://travis-ci.org/Davidslv/preferences.svg?branch=master)](https://travis-ci.org/davidslv/preferences)
+
+This gem is an extraction of the [Spree Ecommerce](https://github.com/spree/spree) Open Source Software.
+
+I couldn't find anything as robust as their solution so I decided to extract it into a gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'preferencias'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install preferencias
+
+Run migrations
+
+    $ rails generate preferencias:migration
+    $ bundle exec rake db:migrate db:test:prepare
+
+## Usage
+
+```ruby
+class YourModel < ActiveRecord::Base
+  preference :color, :string, default: 'red'
+  preference :number_of_pokemons, :integer, default: 151
+end
+
+@model = YourModel.create(preferences: {number_of_pokemons: 649})
+@model.preferred_number_of_pokemons # => 649
+@model.preferred_color # => "red"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/davidslv/preferences/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/generators/preferences/migration_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Preferencias
+  class MigrationGenerator < ::Rails::Generators::Base
+    include ::Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+
+    def self.next_migration_number( dirname )
+      next_migration_number = current_migration_number(dirname) + 1
+      if ActiveRecord::Base.timestamped_migrations
+        [Time.now.utc.strftime("%Y%m%d%H%M%S%6N"), "%.20d" % next_migration_number].max
+      else
+        "%.3d" % next_migration_number
+      end
+    end
+
+    def create_model_file
+      migration_template "create_preferences.rb", "db/migrate/create_preferences.rb"
+    end
+  end
+end

data/lib/generators/preferences/templates/create_preferences.rb

@@ -0,0 +1,10 @@
+class CreatePreferences < ActiveRecord::Migration
+  def change
+    create_table "preferences", force: true do |t|
+      t.text     "value"
+      t.string   "key"
+    end
+
+    add_index "preferences", ["key"], name: "preferences_on_key", unique: true, using: :btree
+  end
+end

data/lib/preferences/preferences/preferable_class_methods.rb

@@ -0,0 +1,51 @@
+module Preferencias
+  module PreferableClassMethods
+
+    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/preferencias.rb

@@ -0,0 +1,7 @@
+require "preferencias/version"
+
+module Preferencias
+  module Rails
+    require 'preferencias/engine'
+  end
+end

data/lib/preferencias/base.rb

@@ -0,0 +1,14 @@
+require 'active_record'
+
+module Preferencias
+  class Base < ActiveRecord::Base
+    include Preferencias::Preferable
+
+    serialize :preferences, Hash
+    after_initialize do
+      self.preferences = default_preferences.merge(preferences) if has_attribute?(:preferences)
+    end
+
+    self.abstract_class = true
+  end
+end

data/lib/preferencias/engine.rb

@@ -0,0 +1,17 @@
+require 'preferencias/preferences/preferable_class_methods'
+require 'preferencias/preferences/preferable'
+require 'preferencias/base'
+require 'preferencias/preferences/configuration'
+require 'preferencias/preferences/scoped_store'
+require 'preferencias/preferences/store'
+require 'preferencias/preference.rb'
+
+require 'rails'
+
+module Preferencias
+  class Engine < ::Rails::Engine
+    initializer "preferences" do
+      ::ActiveRecord::Base.send :include, Preferencias::Preferable
+    end
+  end
+end

data/lib/preferencias/preference.rb

@@ -0,0 +1,6 @@
+module Preferencias
+  class Preference < Base
+    serialize :value
+    validates :key, presence: true, uniqueness: true
+  end
+end

data/lib/preferencias/preferences/configuration.rb

@@ -0,0 +1,71 @@
+# This takes the preferrable methods and adds some
+# syntatic sugar to access the preferences
+#
+# class App < Configuration
+#   preference :color, :string
+# end
+#
+# a = App.new
+#
+# setters:
+# a.color = :blue
+# a[:color] = :blue
+# a.set :color = :blue
+# a.preferred_color = :blue
+#
+# getters:
+# a.color
+# a[:color]
+# a.get :color
+# a.preferred_color
+#
+#
+module Preferencias
+  class Configuration
+    include Preferencias::Preferable
+
+    def configure
+      yield(self) if block_given?
+    end
+
+    def preferences
+      ScopedStore.new(self.class.name.underscore)
+    end
+
+    def reset
+      preferences.each do |name, value|
+        set_preference name, preference_default(name)
+      end
+    end
+
+    alias :[] :get_preference
+    alias :[]= :set_preference
+
+    alias :get :get_preference
+
+    def set(*args)
+      options = args.extract_options!
+      options.each do |name, value|
+        set_preference name, value
+      end
+
+      if args.size == 2
+        set_preference args[0], args[1]
+      end
+    end
+
+    def method_missing(method, *args)
+      name = method.to_s.gsub('=', '')
+      if has_preference? name
+        if method.to_s =~ /=$/
+          set_preference(name, args.first)
+        else
+          get_preference name
+        end
+      else
+        super
+      end
+    end
+
+  end
+end

data/lib/preferencias/preferences/preferable.rb

@@ -0,0 +1,116 @@
+# Preferable allows defining preference accessor methods.
+#
+# A class including Preferable must implement #preferences which should return
+# an object responding to .fetch(key), []=(key, val), and .delete(key).
+#
+# The generated writer method performs typecasting before assignment into the
+# preferences object.
+#
+# Examples:
+#
+#   # Base includes Preferable and defines preferences as a serialized
+#   # column.
+#   class Settings < Base
+#     preference :color,       :string,  default: 'red'
+#     preference :temperature, :integer, default: 21
+#   end
+#
+#   s = Settings.new
+#   s.preferred_color # => 'red'
+#   s.preferred_temperature # => 21
+#
+#   s.preferred_color = 'blue'
+#   s.preferred_color # => 'blue'
+#
+#   # Typecasting is performed on assignment
+#   s.preferred_temperature = '24'
+#   s.preferred_color # => 24
+#
+#   # Modifications have been made to the .preferences hash
+#   s.preferences #=> {color: 'blue', temperature: 24}
+#
+#   # Save the changes. All handled by activerecord
+#   s.save!
+
+require 'active_support'
+
+module Preferencias::Preferable
+  extend ActiveSupport::Concern
+
+  included do
+    extend Preferencias::PreferableClassMethods
+  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
+    else
+      value
+    end
+  end
+end