multi_mappable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 085ec8b6c42883b155a22969b050c710f62bdd18
+  data.tar.gz: ad66eedfd9084a44743c4830c5c84eb017fd75cb
+SHA512:
+  metadata.gz: 016a9ba2fc760316cf423777e42a002e962864b11a463e7ac425a6351ef425d6af162a7afdfc0cc7e6e1e22bf807e28348db380fda2c0d6239d44ae91fc85b5d
+  data.tar.gz: 62401430b3c9af9383f07bce44207ed1a67bf71e847a76a7419e7f2e37d4e306766d5542cd4cf834e724ea4c12613cf0f18309c27ce3488ca9e58af46cdd3f95

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 UCI, OIT
+
+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,56 @@
+# MultiMappable
+
+Ruby gem mixing Virtus and ROXML to produce objects that can map between attributes and XML.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'multi_mappable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multi_mappable
+
+## Usage
+
+````ruby
+  class Person
+    include MultiMappable
+    
+    element name: :name, type: String
+    element name: :address, type: String
+  end
+  
+  class Contact
+    include MultiMappable
+    
+    element name: :people, type: Array[Person], opts: { as: [Person] }
+  end
+  
+  > p = Person.new
+  > p.name = "Zot"
+  > p.address = "UCI"
+  > c = Contact.new(people: [p])
+  > c.to_s
+  
+  # Produces
+  <contact>
+    <person>
+      <name>Zot</name>
+      <address>UCI</address>
+    </person>
+  </contact>
+````
+
+## Contributing
+
+1. Fork it ( https://github.com/ucirvine/multi_mappable/fork )
+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,24 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MultiMappable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+

data/lib/multi_mappable.rb

@@ -0,0 +1,5 @@
+require "multi_mappable/version"
+require "multi_mappable/multi_mappable"
+
+module MultiMappable
+end

data/lib/multi_mappable/multi_mappable.rb

@@ -0,0 +1,29 @@
+require 'roxml'
+require 'virtus'
+
+module MultiMappable
+  module ClassMethods
+    def post_element(post_element = nil)
+      return(@post_element || {}) unless post_element.present?
+      @post_element = post_element
+    end
+  
+    def element(args)
+      opts = args.fetch(:opts, {})
+      attribute args[:name], args[:type]
+      xml_accessor args[:name], opts.merge(post_element)
+    end
+  end
+  
+  def self.included(base)
+    base.class_eval do
+      include ROXML
+      include Virtus.model
+    end
+    base.extend(ClassMethods)
+  end
+  
+  def to_s
+    to_xml.to_s
+  end
+end

data/lib/multi_mappable/version.rb

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

data/multi_mappable.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multi_mappable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "multi_mappable"
+  spec.version       = MultiMappable::VERSION
+  spec.authors       = ["Jose Hales-Garcia"]
+  spec.email         = ["jose.halesgarcia@uci.edu"]
+  spec.summary       = %q{Map attributes and XML.}
+  spec.description   = %q{Mix Virtus and ROXML to produce objects that can map between attributes and XML.}
+  spec.homepage      = "https://github.com/ucirvine/multi_mappable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "virtus"
+  spec.add_dependency "roxml"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency "debugger"
+end

data/spec/multi_mappable_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe MultiMappable do
+  let(:name) { "Zot" }
+  let(:address) { "UCI" }
+  let(:obj) { Contact.new(people: [Person.new(name: name, address: address)]) }
+  
+  subject { obj.to_s.split.join }
+  it "converts attributes to XML" do
+    expect(subject).to eq(%{<contact><person><name>#{name}</name><address>#{address}</address></person></contact>})
+  end
+end
+
+class Person
+  include MultiMappable
+  
+  element name: :name, type: String
+  element name: :address, type: String
+end
+
+class Contact
+  include MultiMappable
+  
+  element name: :people, type: Array[Person], opts: { as: [Person] }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'multi_mappable'
+require 'rspec/autorun'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+# 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"` 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
+
+  # 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

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: multi_mappable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jose Hales-Garcia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  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'
+- !ruby/object:Gem::Dependency
+  name: roxml
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: 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: debugger
+  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'
+description: Mix Virtus and ROXML to produce objects that can map between attributes
+  and XML.
+email:
+- jose.halesgarcia@uci.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/multi_mappable.rb
+- lib/multi_mappable/multi_mappable.rb
+- lib/multi_mappable/version.rb
+- multi_mappable.gemspec
+- spec/multi_mappable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ucirvine/multi_mappable
+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: Map attributes and XML.
+test_files:
+- spec/multi_mappable_spec.rb
+- spec/spec_helper.rb