active_hash_fields 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69fa18f40e4f324b1357b1461e45b135258e383a
+  data.tar.gz: a052a4c6c1f55bd403452aa7579fc82d73d08e36
+SHA512:
+  metadata.gz: 5f0ea59e94bac76a890c5e21160e8f1e351f6bc51b586049c3e82775068891c26eb77083c05d264a8c796af53c0d2efa1682a533dbf139982579ea19baa1d11d
+  data.tar.gz: 221f1b3be52508a91ea4aa5d7df389cb1bab8c0afbad4ba9a064f869c2180c43edb0cbb689480219b4f1dbab07c30d2419cfa8fa6e350aeda2a4ee5aae857ec5

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem 'activerecord', '~> 3.2.0'
+
+group :development do
+  gem 'rspec'
+  gem 'sqlite3'
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", git: 'https://github.com/technicalpickles/jeweler'
+end

data/Gemfile.lock

@@ -0,0 +1,85 @@
+GIT
+  remote: https://github.com/technicalpickles/jeweler
+  revision: f7e0a55a207d83f56637dd8fbabf26a803410faf
+  specs:
+    jeweler (1.8.7)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+    activerecord (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.14)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    addressable (2.3.5)
+    arel (3.0.2)
+    builder (3.0.4)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    i18n (0.6.5)
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.8.0)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    sqlite3 (1.3.8)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.2.0)
+  bundler (~> 1.0)
+  jeweler!
+  rdoc (~> 3.12)
+  rspec
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Roman Snitko
+
+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.markdown

@@ -0,0 +1,48 @@
+active_hash_fields
+======
+
+*An ActiveRecord extension to add serialized hash fields that act like objects*
+
+Usecase
+------------------------
+A `User` should be able to set various notification options for various events. For example, he may want to receive an email notification when someone leaves a comment for his blog post, but not when someone replies with a comment to his comment.
+
+This can usually be solved by either creating an additional associated model like `NotificationSettings` or by creating numerous fields in the `User` model itself. Not quite efficient either way.
+
+Usage
+------------------------
+
+Here's the solution:
+
+    class User < ActiveRecord::Base
+
+      active_hash_fields :notitications,
+        comments_to_my_posts:    true,
+        comments_to_my_comments: false,
+        someone_friended_me:     true,
+        new_private_message:     true    
+
+    end
+
+
+Now you can do things like:
+
+    # Default values are the ones set in the model,
+    # here we just redefine one
+    user = User.new(notifications: { comments_to_my_posts: false })
+
+    user.notifications.comments_to_my_posts # => false
+    user.notifications.new_private_message  # => true
+
+
+IMPORTANT NOTE
+if you don't set a default value for the field, it will be ignore, that is:
+
+    user.notifications.some_non_existent_field = true
+    user.notifications.some_non_existent_field # => nil
+
+
+INSTALLATION
+------------
+
+	  gem install active_hash_fields

data/Rakefile

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+require 'active_record'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "active_hash_fields"
+  gem.homepage = "http://github.com/snitko/active_hash_fields"
+  gem.license = "MIT"
+  gem.summary = %Q{Adds nested fields to an AR model}
+  gem.description = %Q{Adds nested fields to an AR model stored in a serialized field as hash}
+  gem.email = "roman.snitko@gmail.com"
+  gem.authors = ["Roman Snitko"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "active_hash_fields #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+dbconfig = YAML::load(File.open('db/database.yml'))
+ActiveRecord::Base.establish_connection(dbconfig)
+
+namespace :db do
+
+  task :migrate do
+    ActiveRecord::Migration.verbose = true
+    ActiveRecord::Migrator.migrate File.dirname(__FILE__) + '/db/migrations', ENV['VERSION'] ? ENV['VERSION'].to_i : nil
+    ActiveRecord::SchemaDumper.dump ActiveRecord::Base.connection, File.open(File.dirname(__FILE__) + '/db/schema.rb', 'w')
+  end
+
+  task :rollback do
+    ActiveRecord::Migration.verbose = true
+    ActiveRecord::Migrator.down File.dirname(__FILE__) + '/db/migrations', ENV['VERSION'] ? ENV['VERSION'].to_i : nil
+    ActiveRecord::SchemaDumper.dump ActiveRecord::Base.connection, File.open(File.dirname(__FILE__) + '/db/schema.rb', 'w')
+  end
+
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/active_hash_fields.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "active_hash_fields"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Roman Snitko"]
+  s.date = "2013-09-27"
+  s.description = "Adds nested fields to an AR model stored in a serialized field as hash"
+  s.email = "roman.snitko@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "active_hash_fields.gemspec",
+    "db/database.yml",
+    "db/migrations/1_create_dummy.rb",
+    "db/schema.rb",
+    "db/test.sqlite3",
+    "lib/active_hash_fields.rb",
+    "spec/lib/active_hash_fields_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/snitko/active_hash_fields"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.3"
+  s.summary = "Adds nested fields to an AR model"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, ["~> 3.2.0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, ["~> 3.2.0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, ["~> 3.2.0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/db/database.yml

@@ -0,0 +1,4 @@
+adapter:  sqlite3
+database: db/test.sqlite3
+pool: 5
+timeout: 5000

data/db/migrations/1_create_dummy.rb

@@ -0,0 +1,9 @@
+class CreateDummy < ActiveRecord::Migration
+
+  def change
+    create_table :dummies do |t|
+      t.text :notifications
+    end
+  end
+
+end

data/db/schema.rb

@@ -0,0 +1,19 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 1) do
+
+  create_table "dummies", :force => true do |t|
+    t.text "notifications"
+  end
+
+end

data/lib/active_hash_fields.rb

@@ -0,0 +1,88 @@
+module ActiveHashFields
+
+  class HashAsObject
+
+    attr_reader :hash
+
+    def initialize(hash, defaults={})
+      hash ||= {}
+      defaults.stringify_keys!; hash.stringify_keys!
+      @hash = defaults.merge(hash)
+      @hash.each { |k,v| @hash[k] = self.class.convert_to_boolean(v) }
+      @hash.delete_if { |k,v| defaults[k].nil? }
+    end
+
+    def method_missing(name, *args, &blk)
+      name = name.to_s
+      if @hash
+        if @hash.has_key?(name)
+          return @hash[name]
+        elsif name.match(/=$/)
+          k = name.sub(/=$/, "")
+          if @hash.has_key?(k)
+            @hash[k] = self.class.convert_to_boolean(args[0])
+          end
+        end
+      else
+        return @hash.send(name, *args, &blk)
+      end
+      nil
+    end
+
+    def self.convert_to_boolean(v)
+      if (v == "1" || v == "true" || v == true)
+        true
+      elsif v == "0" || v == "false" || v == false
+        false
+      else
+        v
+      end
+    end
+
+
+  end
+
+  module ClassMethods
+
+    def hash_field_as_object(field_name, defaults={})
+      self.class_eval do
+        
+        serialize field_name
+
+        after_initialize "initialize_empty_hash_for_#{field_name}", field_name
+        before_validation "write_hash_to_#{field_name}"
+
+        define_method field_name do
+          @hash_as_object_attrs[field_name] ||= HashAsObject.new(read_attribute(field_name), defaults)
+        end
+
+        define_method "#{field_name}=" do |hash|
+          send("initialize_empty_hash_for_#{field_name}")
+          @hash_as_object_attrs[field_name] = HashAsObject.new(hash, defaults)
+          @hash_as_object_attrs
+        end
+
+        define_method "write_hash_to_#{field_name}" do
+          write_attribute field_name, @hash_as_object_attrs[field_name].hash
+        end
+
+        define_method "initialize_empty_hash_for_#{field_name}" do
+          @hash_as_object_attrs ||= {}
+          #write_attribute(field_name, defaults) if read_attribute(field_name).nil?
+        end
+
+      end
+    end
+
+  end
+
+  module ActiveRecordExtension
+    def active_hash_fields(field_name, defaults={})
+      self.extend ActiveHashFields::ClassMethods
+      hash_field_as_object(field_name, defaults)
+    end
+  end
+
+end
+
+ActiveRecord::Base.extend ActiveHashFields::ActiveRecordExtension

data/spec/lib/active_hash_fields_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+class Dummy < ActiveRecord::Base
+  active_hash_fields :notifications,
+    hello:                   false,
+    hi:                      false,
+    some_boolean_value:      false,
+    answers_to_my_questions: true,
+    news:                    false
+end
+
+describe ActiveHashFields do
+
+  before(:each) do
+    @dummy = Dummy.create()
+    @dummy.notifications = { "hello" => "hello", "hi" => "hi", "some_boolean_value" => "1" }
+  end
+
+  it "gets hash values by calling methods on a field" do
+    @dummy.notifications.hello.should == "hello"
+    @dummy.notifications.hi.should    == "hi"
+  end
+
+  it "converts 0 and 1 strings to boolean values" do
+    @dummy.valid?
+    @dummy.notifications.some_boolean_value.should be_true
+    @dummy.notifications.some_boolean_value = "0"
+    @dummy.notifications.some_boolean_value.should be_false
+  end
+
+  it "sets default values to the hash as soon as object is initialized" do
+    user1 = Dummy.new(notifications: { news: false } )
+    user2 = Dummy.new
+    user3 = Dummy.create(notifications: { news: "true" })
+    user1.notifications.should_not be_nil
+    user2.notifications.should_not be_nil
+    user3.notifications.news.should be_true
+  end
+  
+  it "removes hash elements that are not listed in default values" do
+    @dummy.notifications = { "nonexistent_key" => true }
+    @dummy.notifications.nonexistent_key.should be_nil
+    @dummy.notifications.nonexistent_key = true
+    @dummy.notifications.nonexistent_key.should be_nil
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+RSpec.configure do |config|
+  # Remove this line if you don't want RSpec's should and should_not
+  # methods or matchers
+  require 'rspec/expectations'
+  config.include RSpec::Matchers
+
+  # == Mock Framework
+  config.mock_with :rspec
+
+  require 'active_record'
+  require File.dirname(__FILE__) + '/../lib/active_hash_fields'
+
+  config.before(:suite) do
+    dbconfig = YAML::load(File.open(File.dirname(__FILE__) + '/../db/database.yml'))
+    ActiveRecord::Base.establish_connection(dbconfig)
+  end
+
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: active_hash_fields
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roman Snitko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  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: Adds nested fields to an AR model stored in a serialized field as hash
+email: roman.snitko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.markdown
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- active_hash_fields.gemspec
+- db/database.yml
+- db/migrations/1_create_dummy.rb
+- db/schema.rb
+- db/test.sqlite3
+- lib/active_hash_fields.rb
+- spec/lib/active_hash_fields_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/snitko/active_hash_fields
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Adds nested fields to an AR model
+test_files: []