serial_preference 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in serial_preference.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 amitsuroliya
+
+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,75 @@
+# SerialPreference
+
+If you have a large number of settings/preferences on your model
+(like a company or a businesss) and you store each preference in
+a separate model or in separate columns on the model itself, it
+gets hairy, quickly.
+
+Additionally you require those settings/preferences to be read in
+from a form and then you need an easy way to validate them too.
+
+Personally, I found that putting settings in the database relationally
+was hellish.
+
+SerialPreference stores preferences serialized in a hash in your model.
+All in one place with a DSL to define your settings along with validations
+and other niceties.
+
+Scratching my own itch.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'serial_preference'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install serial_preference
+
+## Usage
+
+    class Company < ActiveRecord::Base
+
+      include SerialPreference::Preferencability # will change this
+
+      preference_map :preferences do
+
+        preference :taxable data_type: :boolean, required: true, label: "Taxable?", hint: "Is this business taxable?"
+        preference :vat_no required: false, label: "VAT"
+        preference :max_invoice_items data_type: :integer
+
+        # default data type is :string
+        # default label is name of preference titleized
+        # if the preference is required, then a validation is added to the model
+        # if the data type is numerical, then a numericality validation is added
+        # preferences can be grouped in preference groups
+
+        preference_group :ledgers, label: "Preferred Ledgers" do
+          income_ledger_id data_type: :integer, default: 1
+        end
+
+        # Let me know what you think of this experimental new DSL?
+
+        + :name_of_preference, data_type: :string
+        + :name_of_another_preference, default: "Hello"
+
+        * :name_of_preference_group, label: "Notifications" do
+          + :email_delivery, data_type: :boolean, default: true
+        end
+
+      end
+
+    end
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/serial_preference/preferencability.rb

@@ -0,0 +1,67 @@
+module Preferencability
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :preference_context
+    class_attribute :preference_storage_attribute
+    self.preference_context = table_name.to_sym
+    self.preference_storage_attribute = :preferences
+  end
+
+  def default_preference_for(name)
+    self.class.default_preference_for(name)
+  end
+
+  def preferences_for(group_name)
+    send(preference_storage_attribute).slice(*self.class.preferences_for(group_name))
+  end
+
+  module ClassMethods
+
+    def preferences_for(group_name)
+      SerialPreference::Preferenzer.group_for(self.preference_context)[group_name].try(:preference_keys) || []
+    end
+
+    def preference_map(store_accessor = :preferences, context = nil, &block)
+      self.preference_context = context || self.preference_context
+      SerialPreference::Preferenzer.draw(preference_context,&block)
+      prefers(store_accessor,preference_context)
+    end
+
+    def default_preference_for(name)
+      SerialPreference::Preferenzer.preference(name,nil,preference_context)
+    end
+
+    def prefers(store_accessor = :preferences, context = nil)
+      self.preference_context = context || self.preference_context
+      self.preference_storage_attribute = store_accessor || self.preference_storage_attribute
+      serialize preference_storage_attribute, Hash
+
+      preferences = SerialPreference::Preferenzer.preferences_for(preference_context)
+
+      preferences.each do |preference|
+        key = preference.name
+        define_method("#{key}=") do |value|
+          send(:preferences)[key] = SerialPreference::Preferenzer.preference(key,value,context)
+          send("preferences_will_change!")
+        end
+
+        define_method(key) do
+          SerialPreference::Preferenzer.preference(key,send(:preferences)[key],context)
+        end
+
+        if preference.required?
+          validates key, :presence => true
+        end
+
+        if preference.numerical?
+          validates key, :numericality => true, :allow_blank => true
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/serial_preference/preference.rb

@@ -0,0 +1,42 @@
+class Preference
+
+  SUPPORTED_TYPES = [:string,:integer,:real,:float,:boolean,:password]
+
+  attr_accessor :data_type, :name, :default, :required, :label, :hint
+
+  def initialize(name,opts = {})
+    self.data_type = opts[:data_type] || :string
+    self.name = name
+    self.default = opts[:default]
+    self.required = !!opts[:required]
+    self.label = opts[:label]
+    self.hint = opts[:hint]
+  end
+
+  def required?
+    required
+  end
+
+  def numerical?
+    [:integer,:float,:real].include?(data_type)
+  end
+
+  def value(value)
+    value = value.presence || default
+    if !value.nil?
+      case data_type
+      when :string, :password
+        value.to_s
+      when  :integer
+        value.to_i
+      when :float, :real
+        value.to_f
+      when :boolean
+        !!value
+      else
+        nil
+      end
+    end
+  end
+
+end

data/lib/serial_preference/preference_group.rb

@@ -0,0 +1,41 @@
+class PreferenceGroup
+
+  attr_accessor :name, :label
+
+  def initialize(name, opts = {})
+    @preferences = {}
+    @name = name
+    @label = opts[:label]
+  end
+
+  def label
+    @label.presence || name.to_s.titleize
+  end
+
+  def preference_keys
+    @preferences.keys
+  end
+
+  def preferences
+    @preferences.values
+  end
+
+  def pref(name,opts = {})
+    @preferences[name] = Preference.new(name,opts)
+  end
+
+  Preference::SUPPORTED_TYPES.each do |dt|
+    define_method dt do |name,opts = {}|
+      pref(name,opts.merge!(:data_type => dt))
+    end
+  end
+
+  def respond_to?(name,*opts)
+    @preferences[name].present?
+  end
+
+  def method_missing(name,*opts,&block)
+    pref(name,*opts)
+  end
+
+end

data/lib/serial_preference/version.rb

@@ -0,0 +1,3 @@
+module SerialPreference
+  VERSION = "0.0.1"
+end

data/lib/serial_preference.rb

@@ -0,0 +1,95 @@
+require 'singleton'
+require "serial_preference/version"
+require 'serial_preference/preference'
+require 'serial_preference/preference_group'
+require "serial_preference/preferencability"
+
+module SerialPreference
+	class Preferenzer
+
+		include Singleton
+
+		attr_accessor :preference_groups, :current_context
+
+		def self.draw(context = :base, &block)
+			i = instance
+			i.preference_groups ||= {}
+			i.preference_groups[context] ||= {}
+			i.current_context = context
+			i.instance_exec(&block)
+		end
+
+    def +(name,opts = {})
+      preference(name,opts)
+    end
+
+    def *(name,opts = {},&block)
+      preference_group(name,opts,&block)
+    end
+
+		def preference(name,opts = {})
+			pg = base_group
+			pg.pref(name,opts)
+		end
+
+		def preference_group(name, opts={},&block)
+			self.preference_groups[current_context] ||= {}
+			self.preference_groups[current_context][name] ||= PreferenceGroup.new(name,opts)
+			self.preference_groups[current_context][name].instance_exec(&block)
+		end
+
+		def self.method_missing(name,*args,&block)
+			if instance.respond_to?(name)
+				instance.send(name,*args,&block)
+			else
+				super
+			end
+		end
+
+		def all_preference_names(context = :base)
+			group_for(context).values.map do |pg|
+				pg.preferences.map do |pref|
+					pref.name
+				end
+			end.flatten
+		end
+
+		def preferences_for(context = :base)
+			group_for(context).values.map do |pg|
+				pg.preferences.map do |pref|
+					pref
+				end
+			end.flatten
+		end
+
+		def each_preference(context = :base)
+			group_for(context).values.each do |pg|
+				pg.preferences.each do |pref|
+					yield(pref)
+				end
+			end
+		end
+
+		def preference(name,value,context = :base)
+			p = preferences_for(context).find{|x| x.name == name }
+			p ? p.value(value) : nil
+		end
+
+		def group_for(context = :base)
+			preference_groups[context] || {}
+		end
+
+		private
+
+		def base_group
+			@base_group ||= begin
+				pg = PreferenceGroup.new(:base,:label => current_context.to_s.titleize)
+				self.preference_groups[current_context] ||= {}
+				self.preference_groups[current_context][:base] = pg
+				pg
+			end
+		end
+
+	end
+end
+

data/serial_preference.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'serial_preference/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "serial_preference"
+  gem.version       = SerialPreference::VERSION
+  gem.authors       = ["Aditya Sanghi"]
+  gem.email         = ["aditya.sanghi@risingsuntech.net"]
+  gem.description   = %q{Serialized Preferences for your models}
+  gem.summary       = %q{Serialized Preferences for your models}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: serial_preference
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Aditya Sanghi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-09 00:00:00.000000000 Z
+dependencies: []
+description: Serialized Preferences for your models
+email:
+- aditya.sanghi@risingsuntech.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/serial_preference.rb
+- lib/serial_preference/preferencability.rb
+- lib/serial_preference/preference.rb
+- lib/serial_preference/preference_group.rb
+- lib/serial_preference/version.rb
+- serial_preference.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Serialized Preferences for your models
+test_files: []