active_xml 0.0.1 → 0.0.2

data/.rspec

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

data/lib/active_xml/collection.rb

@@ -0,0 +1,54 @@
+module ActiveXML
+  class Collection
+    include ActiveXML
+    include Enumerable
+
+    def pluck(key)
+      map do |elem|
+        fetch_contents(elem.elements, key).first
+      end
+    end
+
+    def where(where_values)
+      raise ArgumentError.new("Passing more then 1 where value is currently not possible") if where_values.size > 1
+      Query.new(@path, where_values)
+    end
+
+    def split(route_path)
+      hash = Hash.new
+
+      each do |elem|
+        route = Route.new(route_path, elem)
+        hashed_path = route.to_hash
+        path = Pathname.new(hashed_path.values[0])
+        create_file(path, elem.to_xml)
+        hash.merge!(hashed_path) { |key,old,new| old.class == Array ? old << new[0] : [new,old] }
+      end
+
+      hash
+    end
+
+    def split_to_array(route_path)
+      map do |elem|
+        route = Route.new(route_path, elem)
+        path = Pathname.new(route.generate)
+        create_file(path, elem.to_xml)
+        path
+      end
+    end
+
+    def delete_nodes(keys)
+      keys.each { |key| xml.search(key).first.remove }
+    end
+
+    private
+
+    def root 
+      "objects"
+    end
+
+    def each(&block)
+      xml.child.elements.each(&block)
+    end
+  end
+end

data/lib/active_xml/collection/query.rb

@@ -0,0 +1,27 @@
+module ActiveXML
+  class Collection
+    class Query < Collection
+      def initialize(path, where_values)
+        super(path)
+        @where_key   = where_values.keys.first
+        @where_value = where_values.values.first
+      end
+
+      private
+
+      def each
+        xml.child.elements.each do |elem|
+          yield(elem) if in_where?(elem)
+        end
+      end
+
+      def in_where?(elem)
+        if @where_value.is_a?(Array)
+          @where_value.any?{|object| fetch_contents(elem.elements, @where_key).first == object.to_s}
+        else
+          fetch_contents(elem.elements, @where_key).first == @where_value.to_s
+        end
+      end
+    end
+  end
+end

data/lib/active_xml/collection/route.rb

@@ -0,0 +1,36 @@
+module ActiveXML
+  class Collection
+    class Route
+      attr_reader :keys
+
+      def initialize(route, node)
+        @route = "#{route.clone}"
+        @keys = route_to_keys
+        @node = node
+        @cache = Hash.new
+      end
+
+      def to_hash
+        { read(@keys[0]) => [generate] }
+      end
+
+      def generate
+        @keys.each do |key|
+          @route.gsub!(":#{key}", read(key))
+        end
+
+        "#{@route}.xml"
+      end
+
+      private
+
+      def read(key)
+        @cache[key] || (@cache[key] = @node.search(key.to_s).first.try(:content))
+      end
+
+      def route_to_keys
+        @route.scan(/:[^\/]+/).map{|key| key.gsub(":", "").to_sym}
+      end
+    end
+  end
+end

data/lib/active_xml/object.rb

@@ -0,0 +1,75 @@
+module ActiveXML
+  class Object
+    include ActiveXML
+
+    def delete
+      @path.delete
+    end
+
+    def delete_node(key)
+      find(key).remove
+    end
+
+    def xml=(xml)
+      raise ArgumentError.new("Passed data must be Nokogiri::XML::Document") unless xml.is_a?(Nokogiri::XML::Document)
+      @xml = xml
+    end
+
+    def read_attribute(*keys)
+      result = find(keys.join('/'))
+      is_text_node?(result) ? result.content : result
+    end
+
+    def write_attribute(*keys, value)
+      append_missing_subtree(keys)
+      append_value(keys, value)
+    end
+
+    private
+
+    def root
+      "object"
+    end
+
+    def is_text_node?(node)
+      node && node.children.none?(&:element?)
+    end
+
+    def append_missing_subtree(keys)
+      keys.each_with_index do |key, index|
+        next if find(keys[0..index].join('/'))
+
+        if index == 0 #there is no element at all, searching by css will fail, start from root
+          xml.root.add_child(build_xml_structure(keys))
+        else
+          find(keys[0..index-1].join('/')).add_child(build_xml_structure(keys[index..-1]))
+        end
+      end
+    end
+
+    def append_value(keys, value)
+      css_path = keys.join('/')
+      if value.respond_to?(:to_xml)
+        find(css_path).add_child(Nokogiri::XML(value.to_xml).root)
+      else
+        find(css_path).content = value
+      end
+    end
+
+    def build_xml_structure(keys)
+      Nokogiri::XML::Builder.new do |xml|
+        keys_to_xml_elements(keys.clone, xml)
+      end.doc.root
+    end
+
+    def keys_to_xml_elements(keys, xml)
+      while next_element = keys.shift
+        xml.send(next_element.to_sym) {|x| keys_to_xml_elements(keys, x)}
+      end
+    end
+
+    def find(key)
+      xml.at_css(key.to_s)
+    end
+  end
+end

data/lib/active_xml/version.rb

@@ -1,3 +1,3 @@
 module ActiveXML
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/active_xml/collection/query_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe ActiveXML::Collection::Query do
+  let(:path) { Pathname.new("spec/fixtures/active_xml/example.xml") }
+
+  describe "#pluck(key)" do
+
+    it "works with params as single value" do
+      ActiveXML::Collection::Query.new(path, id: 1).pluck(:name).should == ["Foo"]
+    end
+
+    it "works with params as an array" do
+      ActiveXML::Collection::Query.new(path, id: [1, 2]).pluck(:name).should == ["Foo", "Bar"]
+    end
+  end
+
+  describe "#count" do
+    it "works with params as single value" do
+      ActiveXML::Collection::Query.new(path, id: 1).count.should == 1
+    end
+
+    it "works with params as an array" do
+      ActiveXML::Collection::Query.new(path, id: [1, 2]).count.should == 2
+    end
+  end
+
+  describe "#split" do
+    let(:temp_dir) { Pathname.new(Dir.mktmpdir("test_active_xml_query")) }
+    let(:query) { ActiveXML::Collection::Query.new(path, id: 2) }
+
+    it "split only matched results" do
+      query.split("#{temp_dir}/objects/:id")
+      temp_dir.join('objects/1.xml').should_not exist
+      temp_dir.join('objects/2.xml').should exist
+    end
+
+    it "saves correct data" do
+      query.split("#{temp_dir}/objects/:id")
+      temp_dir.join('objects/2.xml').read.should include('<id>2</id>', '<name>Bar</name>')
+    end
+  end
+end

data/spec/active_xml/collection/route_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe ActiveXML::Collection::Route do
+  describe "new" do
+    it "finds one key" do
+      ActiveXML::Collection::Route.new("this/is/route/with/:key", nil).keys.should == [:key]
+    end
+
+    it "finds multiple keys" do
+      ActiveXML::Collection::Route.new("this/is/route/with/:key/and/:another", nil).keys.should == [:key, :another]
+    end
+  end
+
+  describe "to_hash" do
+    it "generates one element hash" do
+      xml_node = Nokogiri::XML("<object><key>value</key><another>something</another><object>").child
+      route = ActiveXML::Collection::Route.new("this/is/route/with/:key/and/:another", xml_node)
+      route.to_hash.should == { "value" => ["this/is/route/with/value/and/something.xml"] }
+    end
+  end
+
+  describe "generate" do
+    it "generates proper path" do
+      xml_node = Nokogiri::XML("<object><key>value</key><another>something</another><object>").child
+      route = ActiveXML::Collection::Route.new("this/is/route/with/:key/and/:another", xml_node)
+      route.generate.should == "this/is/route/with/value/and/something.xml"
+    end
+  end
+end

data/spec/active_xml/collection_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe ActiveXML::Collection do
+  subject { ActiveXML::Collection.new(path) }
+  let(:path) { Pathname.new("spec/fixtures/active_xml/example.xml") }
+
+  it_behaves_like "active_xml"
+
+  describe "#pluck(key)" do
+    it "returns the array of objects stored in key given in param" do
+      subject.pluck(:name).should == ["Foo", "Bar"]
+    end
+  end
+
+  describe "#count" do
+    it "returns a number of objects in collection" do
+      subject.count.should == 2
+    end
+  end
+
+  describe "#where" do
+    it "returns Query object" do
+      subject.where(id: 1).should be_a(ActiveXML::Collection::Query)
+    end
+
+    it "raises an error if more that one key:value pair passed in where" do
+      expect{ subject.where(id: 1, name: "Foo") }.to raise_error(ArgumentError, "Passing more then 1 where value is currently not possible")
+    end
+  end
+
+  describe "#delete_nodes" do
+    it "deletes given nodes" do
+      subject.delete_nodes(["id","name"])
+      subject.xml.to_s.should_not include('<id>1</id>','<name>Foo</name>')
+      subject.xml.to_s.should     include('<id>2</id>','<name>Bar</name>')
+    end
+  end
+
+  describe "#split" do
+    let(:temp_dir) { Pathname.new(Dir.mktmpdir("test_active_xml_collection")) }
+
+    it "should create 2 files" do
+      subject.split("#{temp_dir}/objects/:id")
+      temp_dir.join('objects/1.xml').should exist
+      temp_dir.join('objects/2.xml').should exist
+    end
+
+    it "new files should have valid content" do
+      subject.split("#{temp_dir}/objects/:id")
+      temp_dir.join('objects/1.xml').read.should include('<id>1</id>', '<name>Foo</name>')
+    end
+
+    it "returns hash of paths" do
+      subject.split("#{temp_dir}/objects/:id").should == {
+        "1" => ["#{temp_dir}/objects/1.xml"],
+        "2" => ["#{temp_dir}/objects/2.xml"]
+      }
+    end
+
+    it "returns hash of paths, each id has array of paths" do
+      collection = ActiveXML::Collection.new("spec/fixtures/active_xml/nested_example.xml")
+      collection.split("#{temp_dir}/objects/:id/:code").should == {
+        "1" => [
+          "#{temp_dir}/objects/1/ABC.xml",
+          "#{temp_dir}/objects/1/ABCD.xml"
+        ],
+        "2" => [
+          "#{temp_dir}/objects/2/CBA.xml",
+        ]
+      }
+    end
+  end
+
+  describe "#split_to_array" do
+    let(:temp_dir) { Pathname.new(Dir.mktmpdir("test_active_xml_collection")) }
+
+    it "should create 2 files" do
+      subject.split_to_array("#{temp_dir}/objects/:id")
+      temp_dir.join('objects/1.xml').should exist
+      temp_dir.join('objects/2.xml').should exist
+    end
+
+    it "new files should have valid content" do
+      subject.split_to_array("#{temp_dir}/objects/:id")
+      temp_dir.join('objects/1.xml').read.should include('<id>1</id>', '<name>Foo</name>')
+    end
+
+    it "returns array of Pathnames" do
+      subject.split_to_array("#{temp_dir}/objects/:id").first.should be_kind_of Pathname
+    end
+
+    it "returns proper Pathname" do
+      subject.split_to_array("#{temp_dir}/objects/:id").first.to_s.should == "#{temp_dir}/objects/1.xml"
+    end
+  end
+end

data/spec/active_xml/object_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+
+describe ActiveXML::Object do
+  subject { ActiveXML::Object.new(path) }
+  let(:path) { Pathname.new("spec/fixtures/active_xml/object.xml") }
+  let(:temp_file) { Pathname.new(Tempfile.new('temp')) }
+
+  it_behaves_like "active_xml"
+
+  describe "self.new" do
+    it "creates a file at given path if it doesnt exist" do
+      temp = temp_file
+      temp.delete
+      ActiveXML::Object.new(temp)
+      temp.should exist
+    end
+  end
+
+  describe "#xml=" do
+    it "raises an error if passed data is not Nokogiri::XML::Document" do
+      expect{ subject.xml = "not an nokogiri document" }.to raise_error(ArgumentError, "Passed data must be Nokogiri::XML::Document")
+    end
+
+    it "replaces nokogiri document with passed one" do
+      new_xml = Nokogiri::XML("<key>value</key>")
+      subject.xml = new_xml
+      subject.xml.should eq(new_xml)
+    end
+  end
+
+  describe "#save" do
+    it "writes stored data to file" do
+      temp_file.open('w') {|f| f.write '<root>value</root>'}
+      object = ActiveXML::Object.new(temp_file)
+      object.xml = Nokogiri::XML("<key>changed value</key>")
+      object.save
+      temp_file.read.should include('<key>changed value</key>')
+    end
+  end
+
+  describe "#read_attribute" do
+    it "returns first found element if string passed" do 
+      subject.read_attribute("city").should == "Wroclaw"
+    end
+
+    it "returns first found element if symbol passed" do 
+      subject.read_attribute(:city).should == "Wroclaw"
+    end
+
+    it "returns nil when key not found" do
+      subject.read_attribute("zip-code").should be_nil
+    end
+
+    it "returns nokogiri object if element has nested keys" do
+      subject.read_attribute(:object).should be_kind_of(Nokogiri::XML::Element)
+    end
+
+    it "build css path from passed arguments" do
+      subject.read_attribute(:object, :city).should == "Wroclaw"
+    end
+  end
+
+  describe "#write_attribute" do
+    context "when given node exists" do
+      it "overwrites found node to given value with string passed as key" do
+        subject.write_attribute("city", "Krakow")
+        subject.xml.to_s.should include("<city>Krakow</city>")
+      end
+
+      it "overwrites found node to given value with symbol passed as key" do
+        subject.write_attribute(:city, "Krakow")
+        subject.xml.to_s.should include("<city>Krakow</city>")
+      end
+
+      it "leaves existing value intact if Nokogiri::XML is passed as value" do
+        value = Nokogiri::XML('<external><internal>val</internal></external>')
+        subject.write_attribute(:city, value)
+        subject.read_attribute(:city, :external, :internal).should  == 'val'
+        subject.read_attribute(:city).to_s.should include('Wroclaw')
+      end
+    end
+
+    context "when given node does not exist" do
+      it "creates node with given key and value with string passed as key" do
+        subject.write_attribute("street", "Basztowa")
+        subject.xml.to_s.should include ("<street>Basztowa</street>")
+      end
+
+      it "creates node with given key and value with string passed as key" do
+        subject.write_attribute(:street, "Basztowa")
+        subject.xml.to_s.should include ("<street>Basztowa</street>")
+      end
+
+      it "creates missing part of tree" do
+        subject.write_attribute(:city, :zipcode, '123')
+        subject.xml.to_s.should include("<zipcode>123</zipcode>")
+      end
+
+      it "leaves existing nodes intact" do
+        subject.write_attribute(:city, :zipcode, '123')
+        subject.xml.to_s.should include('Wroclaw')
+      end
+
+      it "works with Nokogiri::XML objects as values" do
+        value = Nokogiri::XML('<external><internal>val</internal></external>')
+        subject.write_attribute(:city, :zipcode, value)
+        subject.read_attribute(:city, :zipcode, :external, :internal).should  == 'val'
+      end
+    end
+  end
+
+  describe "#set_root!" do
+    it "changes root name by given argument" do
+      subject.stub(root: "new_root")
+      subject.set_root!
+      subject.xml.root.name.should == "new_root"
+    end
+  end
+
+  describe "#delete_node" do
+    it "deletes the nodes from xml" do
+      subject.delete_node('city')
+      subject.xml.search('city').should be_empty
+    end
+  end
+
+  describe "#delete" do
+    it "removes the file" do
+      temp_file.open('w') {|f| f.write '<root>value</root>'}
+      xml = ActiveXML::Object.new(temp_file)
+      xml.delete
+      temp_file.should_not exist
+    end
+  end
+end
+

data/spec/fixtures/active_xml/example.xml

@@ -0,0 +1,10 @@
+<example>
+  <object>
+    <id>1</id>
+    <name>Foo</name>
+  </object>
+  <object>
+    <id>2</id>
+    <name>Bar</name>
+  </object>
+</example>

data/spec/fixtures/active_xml/nested_example.xml

@@ -0,0 +1,17 @@
+<example>
+  <object>
+    <id>1</id>
+    <name>Foo</name>
+    <code>ABC</code>
+  </object>
+  <object>
+    <id>1</id>
+    <name>Foo1</name>
+    <code>ABCD</code>
+  </object>
+  <object>
+    <id>2</id>
+    <name>Bar</name>
+    <code>CBA</code>
+  </object>
+</example>

data/spec/fixtures/active_xml/object.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0"?>
+<object>
+  <city>Wroclaw</city>
+  <country>Poland</country>
+</object>

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'active_xml'
+require 'support/shared_examples/active_xml'
+require 'tempfile'
+# 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

data/spec/support/shared_examples/active_xml.rb

@@ -0,0 +1,19 @@
+shared_examples "active_xml" do
+  describe ActiveXML do
+    describe "#new" do
+      let(:path) { Pathname.new("spec/fixtures/active_xml/example.xml") }
+
+      it "should not raise errors if path to xml file provided" do
+        expect{ subject }.to_not raise_error
+      end
+    end
+
+    describe "#path" do
+      let(:path) { Pathname.new("spec/fixtures/active_xml/example.xml") }
+
+      it "returns the path given in initialiser" do
+        subject.path.should == path
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_xml
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -115,13 +115,27 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - active_xml.gemspec
 - lib/active_xml.rb
+- lib/active_xml/collection.rb
+- lib/active_xml/collection/query.rb
+- lib/active_xml/collection/route.rb
+- lib/active_xml/object.rb
 - lib/active_xml/version.rb
+- spec/active_xml/collection/query_spec.rb
+- spec/active_xml/collection/route_spec.rb
+- spec/active_xml/collection_spec.rb
+- spec/active_xml/object_spec.rb
+- spec/fixtures/active_xml/example.xml
+- spec/fixtures/active_xml/nested_example.xml
+- spec/fixtures/active_xml/object.xml
+- spec/spec_helper.rb
+- spec/support/shared_examples/active_xml.rb
 homepage: ''
 licenses:
 - MIT
@@ -147,5 +161,14 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Nokogiri XML Wrapper
-test_files: []
+test_files:
+- spec/active_xml/collection/query_spec.rb
+- spec/active_xml/collection/route_spec.rb
+- spec/active_xml/collection_spec.rb
+- spec/active_xml/object_spec.rb
+- spec/fixtures/active_xml/example.xml
+- spec/fixtures/active_xml/nested_example.xml
+- spec/fixtures/active_xml/object.xml
+- spec/spec_helper.rb
+- spec/support/shared_examples/active_xml.rb
 has_rdoc: