kissifer-json-attributes 0.0.0

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 kissifer
+
+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.rdoc

@@ -0,0 +1,7 @@
+= json-attributes
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 kissifer. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "json-attributes"
+    gem.summary = %Q{Module to help with initialising/setting/getting object attributes from json strings}
+    gem.email = "tierneydrchris@gmail.com"
+    gem.homepage = "http://github.com/kissifer/json-attributes"
+    gem.authors = ["kissifer"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['--options spec/spec.opts']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "json-attributes #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/json-attributes.gemspec

@@ -0,0 +1,48 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{json-attributes}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["kissifer"]
+  s.date = %q{2009-06-24}
+  s.email = %q{tierneydrchris@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "json-attributes.gemspec",
+     "lib/json-attributes.rb",
+     "lib/monkey_patches.rb",
+     "spec/json-attributes_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kissifer/json-attributes}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Module to help with initialising/setting/getting object attributes from json strings}
+  s.test_files = [
+    "spec/json-attributes_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/json-attributes.rb

@@ -0,0 +1,82 @@
+require 'json/ext'
+require File.expand_path(File.dirname(__FILE__) + '/monkey_patches')
+
+module JsonAttributes
+  module Mixin
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      def json_reader(*syms)
+        attr_reader *syms
+        json_readers.concat(syms)
+      end
+      
+      def json_writer(*syms)
+        attr_writer *syms
+        json_writers.concat(syms)
+      end
+
+      def json_accessor(*syms)
+        attr_accessor *syms
+        json_readers.concat(syms)
+        json_writers.concat(syms)
+      end
+
+      def json_conditioner(*syms)
+        json_conditioners.concat(syms)
+      end
+
+      def json_validator(*syms)
+        json_validators.concat(syms)
+      end
+
+      def json_readers
+        @json_readers ||= []
+      end
+
+      def json_writers
+        @json_writers ||= []
+      end
+
+      def json_conditioners
+        @json_conditioners ||= []
+      end
+
+      def json_validators
+        @json_validators ||= []
+      end
+    end
+    
+    def report_to_json
+      self.class.json_readers.inject({}) do |hash, reader|
+        hash[reader] = send reader
+        hash
+      end.to_json
+    end
+
+    def update_from_json(json)
+      parsed = JSON.parse(json).symbolize_keys!
+      self.class.json_conditioners.each do |conditioner|
+        parsed = send(conditioner, parsed)
+      end
+
+      self.class.json_validators.each do |validator|
+        send(validator, parsed)
+      end
+      
+      parsed.each_pair do |key, value|
+        self.send("#{key}=", value) if self.class.json_writers.include?(key.to_sym)
+      end
+    end
+
+    def create_from_json(json)
+      parsed = JSON.parse(json)
+      raise "Attempt to create without all the required json elements" unless self.class.json_writers.all? do |required|
+        parsed.has_key?(required.to_s)
+      end
+      update_from_json(json)
+    end
+  end
+end 

data/lib/monkey_patches.rb

@@ -0,0 +1,50 @@
+class Hash
+  def assert_valid_keys(*valid_keys)
+    # Lifted from activesupport
+    unknown_keys = keys - [valid_keys].flatten
+    raise(ArgumentError, "Unknown key(s): #{unknown_keys.join(", ")}") unless unknown_keys.empty?
+  end
+  
+  def symbolize_keys!
+    # Lifted from merb
+    each do |key, value|
+      sym = key.respond_to?(:to_sym) ? key.to_sym : key
+      self[sym] = value
+      delete(key) unless key == sym
+    end
+    self
+  end
+end
+
+class Array
+  def assert_valid_elements(*valid_elements)
+    # Lifted from activesupport
+    unknown_elements = self - [valid_elements].flatten
+    raise(ArgumentError, "Unknown elements(s): #{unknown_elements.join(", ")}") unless unknown_elements.empty?
+  end
+
+  def symbolize_elements!
+    collect! do |element|
+      element.respond_to?(:to_sym) ? element.to_sym : element 
+    end
+    self
+  end
+end
+
+module Rack
+  class Request
+    def url_with_no_query
+      url = scheme + "://"
+      url << host
+
+      if scheme == "https" && port != 443 ||
+        scheme == "http" && port != 80
+        url << ":#{port}"
+      end
+
+      url << path
+
+      url
+    end
+  end
+end

data/spec/json-attributes_spec.rb

@@ -0,0 +1,234 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+
+describe "A class that includes JsonAttributes::Mixin" do
+  context "(readers)" do
+    it "should allow the ability to specify attr_readers that are included in the json report" do
+      reader_test_class = Class.new do
+        include JsonAttributes::Mixin
+
+        json_reader :foo, :bar
+
+        def initialize
+          @foo = "food"
+          @bar = "bard"
+        end
+      end
+
+      test = reader_test_class.new
+      test.foo.should == "food"
+      test.bar.should == "bard"
+      test.report_to_json.should == JSON.unparse({:foo => "food", :bar => "bard"})
+    end
+  end
+
+  context "(writers)" do
+    it "should allow the ability to specify attr_writers that can be updated from json" do
+      writer_test_class = Class.new do
+        include JsonAttributes::Mixin
+
+        json_writer :foo, :bar
+        attr_reader :foo, :bar
+
+        def initialize
+          @foo = "food"
+          @bar = "bard"
+        end
+      end
+
+      test = writer_test_class.new
+      test.foo.should == "food"
+      test.bar.should == "bard"
+
+      test.update_from_json(JSON.unparse({:foo => "foof", :bar => "barf"}))
+      test.foo.should == "foof"
+      test.bar.should == "barf"
+
+      test.update_from_json(JSON.unparse({:foo => "fool"}))
+      test.foo.should == "fool"
+      test.bar.should == "barf"
+
+      lambda{test.foo = "foo"}.should_not raise_error
+      lambda{test.bar = "bar"}.should_not raise_error    
+    end
+
+    it "should ignore irrelevant items when updating" do
+      writer_test_class = Class.new do
+        include JsonAttributes::Mixin
+
+        json_writer :foo
+
+        def initialize
+          @foo = "food"
+        end
+      end
+
+      test = writer_test_class.new
+      lambda{test.update_from_json(JSON.unparse({:foo => "foof", :bar => "barf"}))}.should_not raise_error
+    end
+
+    it "should not allow readers to be updated" do
+      writer_test_class = Class.new do
+        include JsonAttributes::Mixin
+
+        json_reader :foo
+
+        def initialize
+          @foo = "food"
+        end
+      end
+
+      test = writer_test_class.new
+      test.update_from_json(JSON.unparse({:foo => "foof"}))
+      test.foo.should == "food"
+    end
+
+    it "should complain about a non hash-like top-level node when updating" do
+      test_class = Class.new do
+        include JsonAttributes::Mixin
+      end
+
+      test = test_class.new
+      lambda{test.update_from_json(JSON.unparse([:foo, "foof"]))}.should raise_error
+    end
+  end
+  
+  context "(accessors)" do
+    it "should allow the ability to specify readable and writable accessors" do
+      accessor_test_class = Class.new do
+        include JsonAttributes::Mixin
+
+        json_accessor :foo, :bar
+
+        def initialize
+          @foo = "food"
+          @bar = "bard"
+        end
+      end
+      
+      test = accessor_test_class.new
+      test.foo = "fool"
+      test.foo.should == "fool"
+      test.update_from_json(JSON.unparse({:foo => "foof"}))
+      test.report_to_json.should == JSON.unparse({:foo => "foof", :bar => "bard"})
+    end
+  end
+  
+  context "(creator)" do
+    it "should provide a create_from_json method that expects ALL of the give json writers" do
+      creator_test_class = Class.new do
+        include JsonAttributes::Mixin
+
+        json_writer :foo, :bar
+        attr_reader :foo, :bar
+
+        def initialize
+          @foo = "food"
+          @bar = "bard"
+        end
+      end
+      
+      test = creator_test_class.new
+      lambda{test.create_from_json(JSON.unparse({:foo => "foof"}))}.should raise_error
+      test.foo.should == "food"
+      test.create_from_json(JSON.unparse({:foo => "foof", :bar => "barf"}))
+      test.foo.should == "foof"
+      test.bar.should == "barf"
+    end
+  end
+  
+  context "(conditioning parsed json)" do
+    before(:each) do
+      @conditioning_test_class = Class.new do
+        include JsonAttributes::Mixin
+
+        json_writer :foo
+        attr_reader :foo
+        
+        json_conditioner :call_me_first, :call_me_after
+
+        def initialize
+          @foo = "food"
+        end
+      end
+    end
+    
+    context "during update" do
+      it "should allow the parsed json to be conditioned in a controller way" do
+      
+        test = @conditioning_test_class.new
+        test.should_receive(:call_me_first).with({:foo => "foof"}).and_return({:foo => "fool"})
+        test.should_receive(:call_me_after).with({:foo => "fool"}).and_return({:foo => "foot"})
+        test.update_from_json(JSON.unparse({:foo => "foof"}))
+        test.foo.should == "foot"
+      end
+    end
+
+    context "during create" do
+      it "should allow the parsed json to be conditioned in a controller way" do
+      
+        test = @conditioning_test_class.new
+        test.should_receive(:call_me_first).with({:foo => "foof"}).and_return({:foo => "fool"})
+        test.should_receive(:call_me_after).with({:foo => "fool"}).and_return({:foo => "foot"})
+        test.create_from_json(JSON.unparse({:foo => "foof"}))
+        test.foo.should == "foot"
+      end
+    end
+  end
+
+  context "(validating parsed json)" do
+    before(:each) do
+      @validating_test_class = Class.new do
+        include JsonAttributes::Mixin
+
+        json_writer :foo
+        attr_reader :foo
+        
+        json_conditioner :condition
+        json_validator :validator_1, :validator_2
+
+        def initialize
+          @foo = "food"
+        end
+      end
+    end
+    
+    context "during update" do
+      it "should not update the object if a validator rasies an error" do
+        test = @validating_test_class.new
+        test.should_receive(:condition).and_return({:foo => "fool"})
+        test.should_receive(:validator_1).with({:foo => "fool"})
+        test.should_receive(:validator_2).with({:foo => "fool"}).and_raise("Something did not validate")
+
+        lambda{test.update_from_json(JSON.unparse({:foo => "foof"}))}.should raise_error("Something did not validate")
+        test.foo.should == "food"
+
+        test.should_receive(:condition).and_return({:foo => "fool"})
+        test.should_receive(:validator_1).with({:foo => "fool"})
+        test.should_receive(:validator_2).with({:foo => "fool"})
+
+        test.update_from_json(JSON.unparse({:foo => "foof"}))
+        test.foo.should == "fool"
+      end
+    end
+
+    context "during create" do
+      it "should not update the object if a validator rasies an error" do
+        test = @validating_test_class.new
+        test.should_receive(:condition).and_return({:foo => "fool"})
+        test.should_receive(:validator_1).with({:foo => "fool"})
+        test.should_receive(:validator_2).with({:foo => "fool"}).and_raise("Something did not validate")
+
+        lambda{test.create_from_json(JSON.unparse({:foo => "foof"}))}.should raise_error("Something did not validate")
+        test.foo.should == "food"
+
+        test.should_receive(:condition).and_return({:foo => "fool"})
+        test.should_receive(:validator_1).with({:foo => "fool"})
+        test.should_receive(:validator_2).with({:foo => "fool"})
+
+        test.create_from_json(JSON.unparse({:foo => "foof"}))
+        test.foo.should == "fool"
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format nested

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'spec'
+require 'json/ext'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'json-attributes'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: kissifer-json-attributes
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- kissifer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-24 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: tierneydrchris@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- json-attributes.gemspec
+- lib/json-attributes.rb
+- lib/monkey_patches.rb
+- spec/json-attributes_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/kissifer/json-attributes
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Module to help with initialising/setting/getting object attributes from json strings
+test_files: 
+- spec/json-attributes_spec.rb
+- spec/spec_helper.rb