parsed 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5bdb8dccd3c53ef25db2c5a9c87fbe2651c41828
+  data.tar.gz: fdd42fdf713581a79e140c0bfdbf512f65ba2654
+SHA512:
+  metadata.gz: 0f7062e41e1e0f2ece126223fff9b77fd9bb19f5ff97637626d7fcc6374fd8ff4ec39e86cbeb16a1744a9f92e3142e04d8e8ceae9c72e5ed008cef0f33db4124
+  data.tar.gz: e7a52e6b4ec6b17b4a644848f78e19a605ea6c17792ab730dd4dc7491ab3e005575cfa49caedae529bc8fc7d7b6e8582c1c4ecbadf21bb8b57d20115dcefe03c

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 parsed.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Robin Roestenburg
+
+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,98 @@
+# Parsed
+
+Parses files into basic Ruby objects. Currently only the JSON format is
+supported. Future versions are planned to support XML, Haml and TOML.
+
+## Why
+
+TODO: Write rationale behind gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'parsed'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install parsed
+
+## How do I use it?
+
+Say, you have a JSON file containing football divisions and their teams:
+
+``` json
+{
+  "name": "Premier League",
+  "country": "England",
+
+  "teams": [
+    {
+      "name": "Arsenal",
+      "city": "London"
+    },
+    {
+      "name": "Swansea City",
+      "city": "Swansea"
+    }
+  ]
+}
+```
+
+You would like to use this data in your Ruby program to create a game.
+
+In order to do this you have two basic models: `League` and `Team`. You declare
+what attributes and collections need to be parsed on those models:
+
+``` ruby
+# file: league.rb
+class League
+  include Parsed::Parseable
+
+  attr_accessor :name, :country, :teams
+
+  parses :name
+  parses :country
+  parses_collection :teams
+
+end
+
+# file: team.rb
+class Team
+  include Parsed::Parseable
+
+  attr_accessor :name, :city
+
+  parses :name
+  parses :city
+
+end
+```
+
+Finally, you parse the JSON file as follows:
+
+``` ruby
+require 'rubygems'
+require 'parsed'
+
+league = League.parse(File.read('premier_league.json'))
+
+p league.name  # => 'Premier League'
+p league.teams # =>
+
+arsenal = league.teams.first
+
+p arsenal.name # => 'Arsenal'
+```
+
+## 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/parsed/parseable.rb

@@ -0,0 +1,66 @@
+require 'json'
+require 'active_support/inflector'
+
+module Parsed
+
+  module Parseable
+
+    def self.included(base)
+      base.instance_variable_set("@fields", [])
+      base.instance_variable_set("@collections", [])
+      base.instance_variable_set("@json", {})
+
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      def parse(json)
+        @json = JSON.parse(json, { :symbolize_names => true })
+
+        instance = new
+        parse_instance(instance)
+        instance
+      end
+
+      def parses(type)
+        @fields << type
+      end
+
+      def parses_collection(type)
+        @collections << type
+      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]
+          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|
+            clazz.parse(element.to_json)
+          end
+
+          instance.send("#{collection}=".to_sym, parsed_elements)
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/parsed/version.rb

@@ -0,0 +1,3 @@
+module Parsed
+  VERSION = '0.1.0'
+end

data/lib/parsed.rb

@@ -0,0 +1,2 @@
+require 'parsed/version'
+require 'parsed/parseable'

data/parsed.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'parsed/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'parsed'
+  gem.version       = Parsed::VERSION
+  gem.authors       = ['Robin Roestenburg']
+  gem.email         = ['robin@roestenburg.io']
+  gem.description   = %q{Parses files into basic Ruby objects. Currently only
+                         the JSON format is supported. Future versions are
+                         planned to support XML, Haml and TOML.}
+  gem.summary       = %q{Write a gem summary}
+  gem.homepage      = 'https://github.com/robinroestenburg/parsed'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'bundler', '~> 1.3'
+  gem.add_development_dependency 'rake'
+
+  gem.add_runtime_dependency 'active_support'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: parsed
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robin Roestenburg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: active_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Parses files into basic Ruby objects. Currently only
+                           the JSON format is supported. Future versions are
+                           planned to support XML, Haml and TOML.
+email:
+- robin@roestenburg.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/parsed.rb
+- lib/parsed/parseable.rb
+- lib/parsed/version.rb
+- parsed.gemspec
+homepage: https://github.com/robinroestenburg/parsed
+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: Write a gem summary
+test_files: []