parsed 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fad66279c57cbc0a81e19e54982931973ec28bd9
-  data.tar.gz: 0aeae4eae56089a78f81898ff8cb71f437d8035f
+  metadata.gz: e649af05fed7637c624567a995d7d42065f94037
+  data.tar.gz: 835ea170f8bcefb50a2504a3dbd0c92844584ad2
 SHA512:
-  metadata.gz: 67959d141ad658007d9ae612773f2a4104b550f854c4b78b602c8b4b9aace7e6d122bf5bcd2962d7d3227b9b3200fa1f80a5e99ef0ab79997a61b29a553bb315
-  data.tar.gz: 0de8c97c5456532ed10d5e5f369c06e1779aeab62438447abb946e60453f8384ede686dde6bf60dee743a58389b38353dd0011bbfdbd335d5fbb9a82211a9274
+  metadata.gz: 8311ecf1b5363788ea33545a48df968cc2fbc52b79c437396361b306c951730989e949ba284fdf90fab9b12b8953e5eb2039927f64e057baf0ce03bed3ce4c8e
+  data.tar.gz: 99bbd5c32f951b0ff7123dbe446e6c2c1168de4b64bd00343356e29b9d03e2b5f842fa3cfd265a9cfd5c731c438e13594f850e42519d7872f375a37a8501d7f5

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/README.md

@@ -52,24 +52,15 @@ what attributes and collections need to be parsed on those models:
 # file: league.rb
 class League
   include Parsed::Parseable
-
   attr_accessor :name, :country, :teams
-
-  parses :name
-  parses :country
-  parses_collection :teams
-
+  parses :name, :country, :teams
 end
 
 # file: team.rb
 class Team
   include Parsed::Parseable
-
   attr_accessor :name, :city
-
-  parses :name
-  parses :city
-
+  parses :name, :city
 end
 ```
 
@@ -78,15 +69,20 @@ Finally, you parse the JSON file as follows:
 ``` ruby
 require 'rubygems'
 require 'parsed'
+require_relative 'league'
+require_relative 'team'
 
 league = League.parse(File.read('premier_league.json'))
 
-p league.name  # => 'Premier League'
-p league.teams # =>
+p league.name
+# => "Premier League"
 
-arsenal = league.teams.first
+p league.teams
+# => [#<Team:0x007fcd18848428 @name="Arsenal", @city="London">,
+#     #<Team:0x007fcd188436d0 @name="Swansea City", @city="Swansea">]
 
-p arsenal.name # => 'Arsenal'
+p league.teams.first.name
+# => "Arsenal"
 ```
 
 ## Contributing

data/lib/parsed/parseable.rb

@@ -5,62 +5,85 @@ module Parsed
 
   module Parseable
 
+    # Callback invoked whenever the receiver is included in another module or
+    # class. This should be used in preference to Module.append_features if your
+    # code wants to perform some action when a module is included in another.
+
     def self.included(base)
-      base.instance_variable_set("@fields", [])
-      base.instance_variable_set("@collections", [])
-      base.instance_variable_set("@json", {})
+
+      # Sets the instance variable names by symbol to object, thereby
+      # frustrating the efforts of the class's author to attempt to provide
+      # proper encapsulation. The variable did not have to exist prior to this
+      # call. If the instance variable name is passed as a string, that string
+      # is converted to a symbol.
+
+      base.instance_variable_set("@parseable_fields",      [])
+      base.instance_variable_set("@parseable_collections", [])
+      base.instance_variable_set("@parseable_json",        {})
+
+      # Adds to obj the instance methods from each module given as a parameter.
 
       base.extend ClassMethods
     end
 
     module ClassMethods
 
-      def parse(json)
-        @json = JSON.parse(json, { :symbolize_names => true })
+      attr_accessor :parseable_json,
+                    :parseable_fields,
+                    :parseable_collections
+
+      def parse(data)
+        @parseable_json = JSON.parse(data, { :symbolize_names => true })
 
         instance = new
-        parse_instance(instance)
+        parse_fields(instance)
         instance
       end
 
-      def parses(type)
-        @fields << type
-      end
-
-      def parses_collection(type)
-        @collections << type
+      # Public: Registers attributes that are to be parsed.
+      #
+      # attributes - The fields to be parsed
+      #
+      # Examples
+      #
+      #   class Foo
+      #     include Parsed::Parseable
+      #     attr_accessor :foo, :bar, :baz
+      #     parsed :foo, :bar, :baz
+      #   end
+      #
+      def parses(*attributes)
+        attributes.each do |attributes|
+          parseable_fields << attributes
+        end
       end
 
       private
 
-      def parse_instance(instance)
-        parse_fields(instance)
-        parse_collections(instance)
-      end
-
       def parse_fields(instance)
-        @fields.each do |field|
-          value = @json[field.to_sym]
+        parseable_fields.each do |field|
+          value = parse_field(field)
           instance.send("#{field}=".to_sym, value)
         end
       end
 
-      def parse_collections(instance)
-        @collections.each do |collection|
-
-          clazz = Kernel.const_get(collection.to_s.singularize.camelize)
-          elements = @json[collection] || []
-
-          parsed_elements = elements.map do |element|
+      def parse_field(field)
+        clazz = determine_collection_class(field)
+        if clazz
+          elements = parseable_json[field.to_sym] || []
+          elements.map do |element|
             clazz.parse(element.to_json)
           end
-
-          instance.send("#{collection}=".to_sym, parsed_elements)
+        else
+          parseable_json[field.to_sym]
         end
       end
 
+      def determine_collection_class(field)
+        field.to_s.singularize.camelize.constantize
+      rescue NameError => e
+        nil
+      end
     end
-
   end
-
 end

data/lib/parsed/version.rb

@@ -1,3 +1,3 @@
 module Parsed
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/parsed.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'bundler', '~> 1.3'
   gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
 
   gem.add_runtime_dependency 'activesupport'
 end

data/spec/parsing_regular_classes_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+class League
+  include Parsed::Parseable
+
+  attr_accessor :name, :country, :teams
+
+  parses :name, :teams
+
+end
+
+class Team
+  include Parsed::Parseable
+
+  attr_accessor :name, :city
+
+  parses :name, :city
+
+end
+
+describe League do
+
+  describe '#parse' do
+
+    describe 'parsing fields' do
+
+      let(:premier_league) do
+        <<-EOS
+        {
+          "name": "Premier League",
+          "country": "England"
+        }
+        EOS
+      end
+
+      subject do
+        League.parse(premier_league)
+      end
+
+      it 'parses fields' do
+        subject.name.should == 'Premier League'
+      end
+
+      it 'skips fields that are not to be parsed' do
+        subject.country.should be_nil
+      end
+
+    end
+
+    describe 'parsing collections' do
+
+      describe 'with elements' do
+
+        let(:premier_league) do
+          <<-EOS
+          {
+            "name": "Premier League",
+
+            "teams": [
+              { "name": "Arsenal", "city": "London" },
+              { "name": "Swansea City", "city": "Swansea" }
+            ]
+          }
+          EOS
+        end
+
+        subject do
+          League.parse(premier_league)
+        end
+
+        it 'returns an object for each element in the collection' do
+          subject.teams.size == 2
+        end
+
+        it 'parses parseable objects inside the collection' do
+          subject.teams.first.name == 'Arsenal'
+          subject.teams.first.city == 'Swansea City'
+        end
+
+      end
+
+      describe 'without elements' do
+
+        let(:premier_league) do
+          <<-EOS
+          {
+            "name": "Premier League",
+            "teams": []
+          }
+          EOS
+        end
+
+        subject do
+          League.parse(premier_league)
+        end
+
+        it 'returns an empty collection' do
+          subject.teams.should be_empty
+        end
+
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'parsed'
+
+# 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
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parsed
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Robin Roestenburg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-01 00:00:00.000000000 Z
+date: 2013-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '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: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -63,6 +77,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -71,6 +86,8 @@ files:
 - lib/parsed/parseable.rb
 - lib/parsed/version.rb
 - parsed.gemspec
+- spec/parsing_regular_classes_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/robinroestenburg/parsed
 licenses:
 - MIT
@@ -95,4 +112,6 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Write a gem summary
-test_files: []
+test_files:
+- spec/parsing_regular_classes_spec.rb
+- spec/spec_helper.rb