mongoid-indifferent-access 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    mongoid-indifferent-access (0.0.1)
+      mongoid
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.2)
+      activesupport (= 3.2.2)
+      builder (~> 3.0.0)
+    activesupport (3.2.2)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    bson (1.6.1)
+    bson (1.6.1-java)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    mongo (1.6.1)
+      bson (~> 1.6.1)
+    mongoid (2.4.6)
+      activemodel (~> 3.1)
+      mongo (~> 1.3)
+      tzinfo (~> 0.3.22)
+    multi_json (1.1.0)
+    rake (0.9.2.2)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    tzinfo (0.3.32)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  mongoid-indifferent-access!
+  rake
+  rspec

data/README.md

@@ -0,0 +1,63 @@
+Mongoid Indifferent Access [![Build Status](https://secure.travis-ci.org/mindscratch/mongoid-indifferent-access.png?branch=master)](http://travis-ci.org/mindscratch/mongoid-indifferent-access)
+==========================
+
+A Mongoid Hash extension enabling "indifferent access" so you can access keys using Strings or Symbols.
+
+[BSON](http://bsonspec.org/) stores document keys as strings, so Hash keys are strings when going into MongoDB and coming out. This extension allows
+a developer to not worry as to whether or not the keys are Strings or Symbols. Instead, by relying on ActiveSupport all Hashes can be
+accessed using whichever approach suites the developer.
+
+Ruby/JRuby
+----------
+Thanks to [travis-ci](http://travis-ci.org) this gem is tested against Ruby 1.9.2, 1.9.3 and JRuby 1.6.7.
+
+Usage
+-----
+
+#### Before
+
+Notice the `nil` values when the Hash values are fetched using Symbols.
+
+````ruby
+class QueryResult
+  include Mongoid::Document
+
+  field :data, type: Hash
+end
+
+# create a QueryResult
+QueryResult.create(data: {name: "google", value: 1.32})
+
+# fetch it back from the database
+result = QueryResult.first
+
+# check its values
+puts result.data["name"]  # => "google"
+puts result.data[:value]  # => nil
+puts result.data[:name]   # => nil
+````
+
+#### After
+
+Notice the values in the Hash can be accessed using Strings or Symbols.
+
+````ruby
+class QueryResult
+  include Mongoid::Document
+  include Mongoid::Extensions::Hash::IndifferentAccess
+
+  field :data, type: Hash
+end
+
+# create a QueryResult
+QueryResult.create(data: {name: "google", value: 1.32})
+
+# fetch it back from the database
+result = QueryResult.first
+
+# check its values
+puts result.data["name"]  # => "google"
+puts result.data[:value]  # => 1.32
+puts result.data[:name]   # => "google"
+puts result.data["value"] # => 1.32
+````

data/Rakefile

@@ -0,0 +1,145 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def lib_name
+  @lib_name ||= name.gsub /-/, '_'
+end
+
+def version
+  line = File.read("lib/#{lib_name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc "Run all specs"
+task RSpec::Core::RakeTask.new('spec')
+
+task :default => "spec"
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  SPEC = eval(File.read(gemspec_file))
+  require_paths = SPEC.require_paths.map {|path| "-I #{path.strip}"}.join(" ")
+  sh "irb -rubygems #{require_paths} -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => [:gemspec, :update_bundle] do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Update #{name} in bundle"
+task :update_bundle => :validate do
+  `bundle update #{name}`
+  puts "Bundled #{name} version #{version}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{lib_name}.rb"] #, "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/lib/mongoid_indifferent_access.rb

@@ -0,0 +1,43 @@
+module Mongoid
+  module Extensions
+    module Hash
+      module IndifferentAccess
+        VERSION = "0.0.1"
+
+        def self.included(klass)
+          klass.class_eval do
+            # @override Mongoid::Field
+            def self.field(name, options={})
+              field = super(name, options)
+
+              # why oh why does sometimes Hash != Hash? something with my environment maybe?
+              # tried ruby 1.9.2-p290 and jruby 1.6.6 (1.9 mode), so we also try checking the class name
+              if options[:type] == Hash || options[:type].name =~ /Hash/
+                getter_name = name.is_a?(Symbol) ? name : name.intern
+                setter_name = "#{getter_name}=".intern
+
+                define_method(getter_name) do
+                  val = super()
+                  unless val.nil? || val.is_a?(HashWithIndifferentAccess)
+                    wrapped_hash = val.with_indifferent_access
+                    self.send(setter_name, wrapped_hash)
+                    val = wrapped_hash
+                  end
+                  val
+                end
+
+                define_method(setter_name) do |hash|
+                  unless hash.nil? || hash.is_a?(HashWithIndifferentAccess)
+                    hash = hash.with_indifferent_access
+                  end
+                  super(hash)
+                end
+              end
+              field
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/mongoid-indifferent-access.gemspec

@@ -0,0 +1,71 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'mongoid-indifferent-access'
+  s.version           = '0.0.1'
+  s.date              = '2012-03-13'
+  s.rubyforge_project = 'mongoid-indifferent-access'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "A Mongoid Hash extension enabling 'indifferent access' so you can access keys using Strings or Symbols."
+  s.description = s.summary
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Craig Wickesser"]
+  s.email    = 'craig@mindscratch.org'
+  s.homepage = 'https://github.com/mindscratch/mongoid-indifferent-access'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib ext/java/jar]
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  ## s.rdoc_options = ["--charset=UTF-8"]
+  ## s.extra_rdoc_files = %w[README LICENSE]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  s.add_dependency 'mongoid'
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  ## s.add_development_dependency('DEVDEPNAME', [">= 1.1.0", "< 2.0.0"])
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    Gemfile.lock
+    README.md
+    Rakefile
+    lib/mongoid_indifferent_access.rb
+    mongoid-indifferent-access.gemspec
+    spec/mongoid-indifferent-access/indifferent_access_spec.rb
+    spec/mongoid.yml
+    spec/spec_helper.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

data/spec/mongoid-indifferent-access/indifferent_access_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'mongoid_indifferent_access'
+require 'mongoid'
+
+# mocking some of what Mongoid::Document would provide
+# so the spec doesn't require having MongoDB running
+class MockSuper
+  attr_accessor :config
+  def self.field(name, options={})
+    nil
+  end
+end
+
+class Guitar < MockSuper
+  include Mongoid::Extensions::Hash::IndifferentAccess
+
+  field :config, :type => Hash
+end
+
+module Mongoid::Extensions::Hash
+
+  describe IndifferentAccess do
+    subject {
+      g = Guitar.new
+      g.config = {:value => 123}
+      g
+    }
+
+    it "returns a value given a String as the key" do
+      subject.config["value"].should eq(123)
+    end
+
+    it "returns a value given a Symbol as the key" do
+      subject.config[:value].should eq(123)
+    end
+
+    it "returns nil given a non-existing key" do
+      subject.config[:non_existant].should be_nil
+    end
+
+  end
+
+end

data/spec/mongoid.yml

@@ -0,0 +1,20 @@
+development:
+  host: localhost
+  database: mongoid_dev
+
+test:
+  host: localhost
+  database: mongoid_test
+
+# set these environment variables on your prod server
+# production:
+#   host: <%= ENV['MONGOID_HOST'] %>
+#     port: <%= ENV['MONGOID_PORT'] %>
+#       username: <%= ENV['MONGOID_USERNAME'] %>
+#         password: <%= ENV['MONGOID_PASSWORD'] %>
+#           database: <%= ENV['MONGOID_DATABASE'] %>
+#             # slaves:
+#               #   - host: slave1.local
+#                 #     port: 27018
+#                   #   - host: slave2.local
+#                     #     port: 27019

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+# RSpec.configure do |config|
+#   config.treat_symbols_as_metadata_keys_with_true_values = true
+#   config.run_all_when_everything_filtered = true
+#   config.filter_run :focus
+# end
+
+require 'rspec/autorun'
+ROOT = File.expand_path('../..', __FILE__)
+Dir[File.join(ROOT, "spec/support/**/*.rb")].each {|f| require f}
+$LOAD_PATH.unshift(File.expand_path('lib', ROOT))

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-indifferent-access
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Craig Wickesser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-13 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &2176859440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2176859440
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2176858660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2176858660
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2176857780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2176857780
+description: A Mongoid Hash extension enabling 'indifferent access' so you can access
+  keys using Strings or Symbols.
+email: craig@mindscratch.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/mongoid_indifferent_access.rb
+- mongoid-indifferent-access.gemspec
+- spec/mongoid-indifferent-access/indifferent_access_spec.rb
+- spec/mongoid.yml
+- spec/spec_helper.rb
+homepage: https://github.com/mindscratch/mongoid-indifferent-access
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- ext/java/jar
+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: mongoid-indifferent-access
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 2
+summary: A Mongoid Hash extension enabling 'indifferent access' so you can access
+  keys using Strings or Symbols.
+test_files: []