saxomattic 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc
+.ruby-version
+.ruby-gemset

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in saxomattr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brandon Dewitt
+
+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,93 @@
+# Saxomattic
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'saxomattic'
+
+Or install it yourself as:
+
+    $ gem install saxomattic
+
+## Usage
+
+Saxomattic is a combination of [sax-machine](https://github.com/pauldix/sax-machine) and [active_attr](https://github.com/cgriego/active_attr)
+If you want to know more about those probjects, check them out!
+
+Saxomattic allows for a declarative syntax to define "models" that are mappable to xml documents so xml parsing
+is declarative (through sax-machine semantics) and typecasting/attribute presence/default values are provided by
+active_attr.  So.......how about an example? (let's walk through the spec example)
+
+```ruby
+  class SaxTesterEmbedception
+    include Saxomattic
+
+    attribute :type, :attribute => true
+    attribute :value, :value => true
+    attribute :not_even_used
+  end
+
+  class SaxTesterEmbedded
+    include Saxomattic
+
+    attribute :embed
+    attribute :foo, :type => Integer
+    attribute :embedception, :class => SaxTesterEmbedception
+  end
+
+  class SaxTesterSomething
+    include Saxomattic
+
+    attribute :baz
+    attribute :foo, :type => Integer
+    attribute :iso_8701, :type => Date
+    attribute :date, :type => Date
+    attribute :datetime, :type => DateTime
+    attribute :embedded, :elements => true, :class => SaxTesterEmbedded
+  end
+
+  xml = <<-XML
+    <test>
+      <baz>baz</baz>
+      <iso_8701>2013-01-13</iso_8701>
+      <datetime>2013-08-13T14:45:55-06:00</datetime>
+      <embedded>
+        <foo>2</foo>
+        <embed>HERE!</embed>
+        <embedception type="TYPE">VALUE</embedception>
+      </embedded>
+      <date>2013-08-13</date>
+      <foo>2</foo>
+    </test>
+    XML
+```
+
+The classes above `SaxTesterEmbedception`, `SaxTesterEmbedded`, `SaxTesterSomething` are the data models that map to the xml assigned to variable `xml`.
+Instead of the `sax-machine` `element` syntax we have standardized on using `attribute` to declare the attributes and how a model maps to the xml document. Any override of the attribute that would typically be handled in `sax-machine` by using `elements`, `attribute`, `value` need to be accessed through the hash syntax ... ie `attribute :type, :attribute => true` tells active_attr that the attribute `type` should have setters/getters and tells `sax-machine` that the value should come from the attribute on the xml node `type`.
+
+Parsing xml:
+
+```ruby
+  something = SaxTesterSomething.parse(xml)
+
+  something.baz                               # => baz
+  something.foo                               # => 2
+  something.foo_before_type_cast              # => "2"
+  something.embedded.size                     # => 1
+  something.embedded.first.foo                # => 2
+  something.embedded.first.embedception.type  # => "TYPE"
+  something.embedded.first.embedception.value # => "VALUE"
+```
+
+Based on this short example, hopefully you can see that declaring your data models is a great way to make data models based on xml documents easier to work with. And if you don't .... do something else!
+
+Enjoy!
+
+## 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,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Run specs (default)"
+task :default => :spec

data/lib/saxomattic.rb

@@ -0,0 +1,85 @@
+require "saxomattic/version"
+require "sax-machine"
+require "active_attr"
+require "active_support/core_ext/hash/slice"
+require "active_support/core_ext/array/extract_options"
+require "active_support/core_ext/string/conversions"
+
+module Saxomattic
+  ACTIVE_ATTR_ATTRIBUTES = [
+    :default,
+    :type
+  ].freeze
+
+  SAX_MACHINE_ATTRIBUTES = [
+    :as,
+    :class,
+    :lazy,
+    :value,
+    :with
+  ].freeze
+
+  def self.included(klass)
+    klass.extend(HookManagementMethods)
+    klass.__send__(:include, ::ActiveAttr::Model)
+    klass._capture_active_attr_methods(klass)
+    klass.__send__(:include, ::SAXMachine)
+    klass._capture_sax_machine_methods(klass)
+    klass.extend(ClassMethods)
+  end
+
+  module HookManagementMethods
+    def _capture_active_attr_methods(klass)
+      class << klass
+        alias_method :_active_attr_attribute, :attribute
+      end
+    end
+
+    def _capture_sax_machine_methods(klass)
+      class << klass
+        alias_method :_sax_machine_ancestor, :ancestor
+        alias_method :_sax_machine_attribute, :attribute
+        alias_method :_sax_machine_element, :element
+        alias_method :_sax_machine_elements, :elements
+        alias_method :_sax_machine_value, :value
+      end
+    end
+  end
+
+  module ClassMethods
+    def attribute(*args)
+      options = args.extract_options!
+      field = args.first
+
+      # If you want to setup a default set of elements, you can!
+      # :default => [ true, false, false, true ]
+      if options[:elements] && !options[:elements].kind_of?(Array)
+        options.merge!(:default => [])
+      end
+
+      _active_attr_attribute(field, _active_attr_attributes(options.dup))
+
+      case
+      when options[:ancestor] then
+        _sax_machine_ancestor(field, _sax_machine_attributes(options.dup))
+      when options[:attribute] then
+        _sax_machine_attribute(field, _sax_machine_attributes(options.dup))
+      when options[:elements] then
+        _sax_machine_elements(field, _sax_machine_attributes(options.dup))
+      when options[:value] then
+        _sax_machine_value(field, _sax_machine_attributes(options.dup))
+      else # Default state is an element
+        _sax_machine_element(field, _sax_machine_attributes(options.dup))
+      end
+    end
+
+    def _active_attr_attributes(options_hash = {})
+      options_hash.slice!(::Saxomattic::ACTIVE_ATTR_ATTRIBUTES)
+    end
+
+    def _sax_machine_attributes(options_hash = {})
+      options_hash.slice!(::Saxomattic::SAX_MACHINE_ATTRIBUTES)
+    end
+  end
+
+end

data/lib/saxomattic/version.rb

@@ -0,0 +1,3 @@
+module Saxomattic
+  VERSION = "0.0.1"
+end

data/saxomattic.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'saxomattic/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "saxomattic"
+  gem.version       = Saxomattic::VERSION
+  gem.authors       = ["Brandon Dewitt"]
+  gem.email         = ["brandonsdewitt+saxomattic@gmail.com"]
+  gem.description   = %q{ A gem to combine all the wonderful that is sax-machine with the magic that is active_attr }
+  gem.summary       = %q{ By including a module "Saxomattic" you can declare xml structured documents with active_attr goodies }
+  gem.homepage      = "https://github.com/abrandoned/saxomattic.git"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "active_attr"
+  gem.add_dependency "activesupport"
+  gem.add_dependency "sax-machine"
+
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "simplecov"
+end

data/spec/saxomattic_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+class SaxTesterEmbedception
+  include Saxomattic
+
+  attribute :type, :attribute => true
+  attribute :value, :value => true
+  attribute :not_even_used
+end
+
+class SaxTesterEmbedded
+  include Saxomattic
+
+  attribute :embed
+  attribute :foo, :type => Integer
+  attribute :embedception, :class => SaxTesterEmbedception
+end
+
+class SaxTesterSomething
+  include Saxomattic
+
+  attribute :baz
+  attribute :foo, :type => Integer
+  attribute :iso_8701, :type => Date
+  attribute :date, :type => Date
+  attribute :datetime, :type => DateTime
+  attribute :embedded, :elements => true, :class => SaxTesterEmbedded
+end
+
+describe ::Saxomattic do
+
+  let(:embedded_message) { "HERE!" }
+  let(:embedception_type) { "TYPE" }
+  let(:embedception_value) { "VALUE" }
+  let(:foo) { 2 }
+  let(:baz) { "baz" }
+  let(:xml) {
+    <<-XML
+    <test>
+      <baz>#{baz}</baz>
+      <iso_8701>2013-01-13</iso_8701>
+      <datetime>#{DateTime.current}</datetime>
+      <embedded>
+        <foo>2</foo>
+        <embed>#{embedded_message}</embed>
+        <embedception type="#{embedception_type}">#{embedception_value}</embedception>
+      </embedded>
+      <date>#{Date.today}</date>
+      <foo>2</foo>
+    </test>
+    XML
+  }
+
+  subject { SaxTesterSomething.parse(xml) }
+
+  it "extracts elements when declared as attribute" do
+    subject.baz.should eq(baz)
+  end
+
+  context "TypeCasting" do
+    it "typecasts integers when declared with type => Integer" do
+      subject.foo.should eq(foo)
+    end
+
+    it "typecasts Dates when declared with type => Date" do
+      subject.date.should be_a(Date)
+      subject.date.should eq(Date.today)
+    end
+
+    it "embedded" do
+      subject.embedded.should be_a(Array)
+      subject.embedded.first.embed.should eq(embedded_message)
+    end
+
+    it "typecasts embedded fields" do
+      subject.embedded.first.foo.should eq(foo)
+    end
+
+    it "embeds values further" do
+      subject.embedded.first.embedception?.should be_true
+      subject.embedded.first.embedception.type.should eq(embedception_type)
+      subject.embedded.first.embedception.value.should eq(embedception_value)
+      subject.embedded.first.embedception.not_even_used?.should be_false
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler'
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+Bundler.require(:default, :development, :test)

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: saxomattic
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brandon Dewitt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_attr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sax-machine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! ' A gem to combine all the wonderful that is sax-machine with the magic
+  that is active_attr '
+email:
+- brandonsdewitt+saxomattic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/saxomattic.rb
+- lib/saxomattic/version.rb
+- saxomattic.gemspec
+- spec/saxomattic_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/abrandoned/saxomattic.git
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4328511533199913678
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4328511533199913678
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: By including a module "Saxomattic" you can declare xml structured documents
+  with active_attr goodies
+test_files:
+- spec/saxomattic_spec.rb
+- spec/spec_helper.rb