serialisable 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6fd4b076b8bdcf3bb038edb81861f995b5c64e03
+  data.tar.gz: eff45ba4141fb2eeff36635e4ffa21de831b1dd8
+SHA512:
+  metadata.gz: d3c9d0c2e3e2d7f8973da83a85143e3a8a2e2ffa16770c4e19c074fbd2672e1543b7e1ff95dd3d02ef0b61c13fc00a4e0f034cd587db148705ea146ad946a163
+  data.tar.gz: 86677bd6af34fe7e3f5859a6266e55e67cd0d5dfd87b12b2dfde0b8dccfad10ea83896bcb69a1b8b66c62b310d3380fa13d72b57286dbb78cbc43a978fa2c1f2

data/README.md

@@ -0,0 +1,45 @@
+# Serialisable
+
+Simple xml to object deserialisation for Ruby, built on top of Nokogiri (at the
+moment).
+
+This is still in the hacky stage, so you probably shouldn't use it...
+
+``` xml
+<?xml version="1.0" encoding="utf-8"?>
+<plays>
+  <play>
+    <track>505</track>
+    <artist>Arctic Monkeys</artist>
+    <time>2013-10-12T15:34:50Z</time>
+  </play>
+  <play>
+    <track>Windowlicker</track>
+    <artist>Aphex Twin</artist>
+    <time>2013-10-12T15:37:43Z</time>
+  </play>
+</plays>
+```
+
+``` ruby
+require 'serialisable'
+require 'time'
+
+class Play
+  extend Serialisable
+
+  root 'play'
+  element :track, 'track'
+  element :artist, 'artist'
+  element :time, 'time', Time   # an object responding to #parse
+end
+
+class Plays
+  extend Serialisable
+
+  root 'plays'
+  elements :plays, Play         # a Serialisable object
+end
+
+plays = Plays.deserialise(File.read('plays.xml')).plays
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = true
+end
+
+task :default => :test

data/lib/serialisable.rb

@@ -0,0 +1,136 @@
+require 'nokogiri'
+require_relative 'serialisable/selector'
+
+module Serialisable
+  def root(selector)
+    @__root = selector
+    @__element = {}
+    @__elements = {}
+    @__attribute = {}
+  end
+
+  def attribute(name, selector, type=String)
+    @__attribute[name] = [selector, type]
+  end
+
+  def element(name, selector, type=String)
+    @__element[name] = [selector, type]
+  end
+
+  def elements(name, *args)
+    case args.size
+    when 1
+      klass = args.first
+      @__elements[name] = [nil, klass]
+    when 2
+      selector, type = args
+      @__elements[name] = [selector, type]
+    else
+      raise ArgumentError
+    end
+  end
+
+  def deserialise(xml)
+    __deserialise Nokogiri::XML(xml)
+  end
+
+  private
+
+  def __deserialise_all(doc)
+    doc = doc.children.find_all {|node| node.name == @__root }
+
+    attrs_list = doc.map do |node|
+      attrs = SerialisableHelpers.get_multiples(node, @__elements)
+      attrs += SerialisableHelpers.get_singles(node, @__element)
+      attrs += SerialisableHelpers.get_attributes(node, @__attribute)
+
+      attrs
+    end
+
+    objs = []
+    attrs_list.each do |attrs|
+      attrs = Hash[attrs]
+
+      attrs.each do |key, value|
+        define_method key do
+          instance_variable_get(:@__serialisable_attrs)[key]
+        end
+      end
+
+      obj = new
+      obj.instance_variable_set(:@__serialisable_attrs, attrs)
+      objs << obj
+    end
+
+    objs
+  end
+
+  def __deserialise(doc)
+    doc = doc.children.find {|node| node.name == @__root }
+
+    attrs = SerialisableHelpers.get_multiples(doc, @__elements)
+    attrs += SerialisableHelpers.get_singles(doc, @__element)
+    attrs += SerialisableHelpers.get_attributes(doc, @__attribute)
+
+    attrs = Hash[attrs]
+
+    attrs.each do |key, value|
+      define_method key do
+        instance_variable_get(:@__serialisable_attrs)[key]
+      end
+    end
+
+    obj = new
+    obj.instance_variable_set(:@__serialisable_attrs, attrs)
+    obj
+  end
+end
+
+module SerialisableHelpers
+  extend self
+
+  def get_multiples(root, hash)
+    hash.map do |name, (selector, type)|
+      if type.respond_to?(:__deserialise_all, true)
+        [name, type.send(:__deserialise_all, root)]
+      else
+        values = root.children.find_all {|node| node.name == selector }
+          .map {|node| node.children.to_s }
+          .map {|value| parse_type(value, type) }
+
+        [name, values]
+      end
+    end
+  end
+
+  def get_singles(root, hash)
+    hash.map do |name, (selector, type)|
+      if selector.respond_to?(:__deserialise, true)
+        [name, selector.send(:__deserialise, root)]
+      else
+        value = root.children.find {|node| node.name == selector }.children.to_s
+        value = parse_type(value, type)
+
+        [name, value]
+      end
+    end
+  end
+
+  def get_attributes(root, hash)
+    hash.map do |name, (selector, type)|
+      value = root.attributes[selector].value
+      value = parse_type(value, type)
+
+      [name, value]
+    end
+  end
+
+  # Parses the value read from xml if the type given responds to the method
+  # #parse, otherwise returns the string value.
+  #
+  # @param value [String]
+  # @param type [#parse]
+  def parse_type(value, type)
+    type.respond_to?(:parse) ? type.parse(value) : value
+  end
+end

data/lib/serialisable/version.rb

@@ -0,0 +1,3 @@
+module Serialisable
+  VERSION = '0.0.0'
+end

data/spec/serialisable_spec.rb

@@ -0,0 +1,312 @@
+require_relative 'spec_helper'
+
+describe Serialisable do
+
+  describe '#element' do
+    describe 'with a single element' do
+
+      subject {
+        Class.new {
+          extend Serialisable
+
+          root 'root'
+          element :node, 'node'
+        }
+      }
+
+      let(:xml) {
+        '<?xml version="1.0" encoding="utf-8"?><root><node>value</node></root>'
+      }
+
+      it 'takes xml and returns an object' do
+        subject.deserialise(xml).node.must_equal 'value'
+      end
+    end
+
+    describe 'with an single element with a type to parse' do
+      subject {
+        require 'time'
+
+        Class.new {
+          extend Serialisable
+
+          root 'root'
+          element :time, 'time', Time
+        }
+      }
+
+      let(:xml) {
+        '<?xml version="1.0" encoding="utf-8"?><root><time>2013-07-04T13:23:34Z</time></root>'
+      }
+
+      it 'takes xml and returns an object with the type parsed' do
+        subject.deserialise(xml).time.must_equal Time.utc(2013, 7, 4, 13, 23, 34)
+      end
+    end
+
+    describe 'with a nested serialisable' do
+      subject {
+        Class.new {
+          extend Serialisable
+
+          root 'songs'
+          element :song, Class.new {
+            extend Serialisable
+
+            root 'song'
+            element :artist, 'artist'
+            element :name, 'name'
+          }
+        }
+      }
+
+      let(:xml) {
+        <<EOS
+<?xml version="1.0" encoding="utf-8"?>
+<songs>
+  <song>
+    <artist>Arctic Monkeys</artist>
+    <name>505</name>
+  </song>
+</songs>
+EOS
+      }
+
+      it 'deserialises the nested object correctly' do
+        result = subject.deserialise(xml)
+
+        result.song.artist.must_equal 'Arctic Monkeys'
+        result.song.name.must_equal '505'
+      end
+    end
+  end
+
+  describe '#elements' do
+    describe 'with a single list of elements' do
+      subject {
+        require 'time'
+
+        Class.new {
+          extend Serialisable
+
+          root 'root'
+          elements :times, 'time', Time
+        }
+      }
+
+      let (:xml) {
+        '<?xml version="1.0" encoding="utf-8"?><root><time>2013-05-06T00:00:00Z</time><time>2013-06-07T00:00:00Z</time></root>'
+      }
+
+      it 'takes xml and returns an object with a list of results' do
+        times = subject.deserialise(xml).times
+        times.must_equal [Time.utc(2013, 5, 6), Time.utc(2013, 6, 7)]
+      end
+    end
+
+    describe 'with a list of nested objects' do
+      subject {
+        Class.new {
+          extend Serialisable
+
+          root 'songs'
+          elements :songs, Class.new {
+            extend Serialisable
+
+            root 'song'
+            element :artist, 'artist'
+            element :name, 'name'
+          }
+        }
+      }
+
+      let(:xml) {
+        <<EOS
+<?xml version="1.0" encoding="utf-8"?>
+<songs>
+  <song>
+    <artist>Arctic Monkeys</artist>
+    <name>505</name>
+  </song>
+  <song>
+    <artist>Aphex Twin</artist>
+    <name>Windowlicker</name>
+  </song>
+</songs>
+EOS
+      }
+
+      it 'takes xml and returns an object with a list of nested objects' do
+        result = subject.deserialise(xml)
+
+        result.songs.length.must_equal 2
+
+        result.songs[0].artist.must_equal 'Arctic Monkeys'
+        result.songs[0].name.must_equal '505'
+
+        result.songs[1].artist.must_equal 'Aphex Twin'
+        result.songs[1].name.must_equal 'Windowlicker'
+      end
+    end
+
+    it 'raises an exception if not given less than two arguments' do
+      lambda {
+        Class.new {
+          extend Serialisable
+
+          elements :name
+        }
+      }.must_raise ArgumentError
+    end
+
+    it 'raises an exception if given more than three arguments' do
+      lambda {
+        Class.new {
+          extend Serialisable
+
+          elements :name, 'one', 'two', 'three'
+        }
+      }.must_raise ArgumentError
+    end
+  end
+
+  describe '#attribute' do
+    describe 'with a single attribute' do
+      subject {
+        Class.new {
+          extend Serialisable
+
+          root 'item'
+          attribute :id, 'id'
+        }
+      }
+
+      let(:xml) {
+        '<?xml version="1.0" encoding="utf-8"?><item id="1234" />'
+      }
+
+      it 'takes xml and returns an object with the attribute deserialised' do
+        subject.deserialise(xml).id.must_equal '1234'
+      end
+    end
+
+    describe 'with an attribute with a type' do
+      subject {
+        require 'time'
+        Class.new {
+          extend Serialisable
+
+          root 'item'
+          attribute :at, 'at', Time
+        }
+      }
+
+      let(:xml) {
+        '<?xml version="1.0" encoding="utf-8"?><item at="2013-10-10T15:30:34Z" />'
+      }
+
+      it 'takes xml and returns an object with the attribute parsed' do
+        subject.deserialise(xml).at.must_equal Time.utc(2013, 10, 10, 15, 30, 34)
+      end
+    end
+
+    describe 'with an attribute on a nested object' do
+      subject {
+        Class.new {
+          extend Serialisable
+
+          root 'items'
+          element :item, Class.new {
+            extend Serialisable
+
+            root 'item'
+            attribute :id, 'id'
+          }
+        }
+      }
+
+      let(:xml) {
+        '<?xml version="1.0" encoding="utf-8"?><items><item id="1234" /></items>'
+      }
+
+      it 'takes xml and returns an object with the attribute deserialised' do
+        subject.deserialise(xml).item.id.must_equal '1234'
+      end
+    end
+
+    describe 'with an attribute on a list of nested object' do
+      subject {
+        Class.new {
+          extend Serialisable
+
+          root 'items'
+          elements :items, Class.new {
+            extend Serialisable
+
+            root 'item'
+            attribute :id, 'id'
+          }
+        }
+      }
+
+      let(:xml) {
+        '<?xml version="1.0" encoding="utf-8"?><items><item id="1234" /><item id="5678" /></items>'
+      }
+
+      it 'takes xml and returns an object with the attribute deserialised' do
+        items = subject.deserialise(xml).items
+
+        items[0].id.must_equal '1234'
+        items[1].id.must_equal '5678'
+      end
+    end
+  end
+
+  describe 'all together' do
+    let(:xml) {
+      <<EOS
+<?xml version="1.0" encoding="utf-8"?>
+<plays>
+  <play>
+    <track>505</track>
+    <artist>Arctic Monkeys</artist>
+    <time>2013-10-12T15:34:50Z</time>
+  </play>
+  <play>
+    <track>Windowlicker</track>
+    <artist>Aphex Twin</artist>
+    <time>2013-10-12T15:37:43Z</time>
+  </play>
+</plays>
+EOS
+    }
+
+    subject {
+      Class.new {
+        extend Serialisable
+
+        root 'plays'
+        elements :plays, Class.new {
+          extend Serialisable
+
+          root 'play'
+          element :track, 'track'
+          element :artist, 'artist'
+          element :time, 'time', Time
+        }
+      }
+    }
+
+    it 'works!' do
+      plays = subject.deserialise(xml).plays
+
+      plays[0].track.must_equal '505'
+      plays[0].artist.must_equal 'Arctic Monkeys'
+      plays[0].time.must_equal Time.utc(2013, 10, 12, 15, 34, 50)
+
+      plays[1].track.must_equal 'Windowlicker'
+      plays[1].artist.must_equal 'Aphex Twin'
+      plays[1].time.must_equal Time.utc(2013, 10, 12, 15, 37, 43)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require 'mocha/setup'
+
+require_relative '../lib/serialisable'

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: serialisable
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Joshua Hawxwell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |2
+      Serialisable provides a simple DSL for turning xml into ruby objects.
+email: m@hawx.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/serialisable/version.rb
+- lib/serialisable.rb
+- spec/spec_helper.rb
+- spec/serialisable_spec.rb
+homepage: http://github.com/hawx/serialisable
+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.14
+signing_key: 
+specification_version: 4
+summary: Serialisable allows easy xml deserialisation
+test_files:
+- spec/spec_helper.rb
+- spec/serialisable_spec.rb