noko_builder 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+gem "nokogiri", "~> 1.5.0"
+gem "activesupport", "~> 3.2.1"
+
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+end

data/Gemfile.lock

@@ -0,0 +1,39 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.1)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.5)
+    multi_json (1.0.4)
+    nokogiri (1.5.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 3.2.1)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.8.3)
+  nokogiri (~> 1.5.0)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 frausto
+
+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.rdoc

@@ -0,0 +1,89 @@
+= NokoBuilder
+
+NokoBuilder is a gem that makes building out xml using nokogiri even easier! It gives you the ability to add overwritable default values and attributes to each xml tag, while still maintaining all the stuff you get from the normal nokogiri xml builder.
+
+== Examples
+
+===VALUES
+
+The values for xml tags can be overwritten by passing the value as an option when creating the xml document.
+
+  builder = NokoBuilder.new(options) do |xml|
+    xml.One "default value"
+    xml.Two
+  end
+
+If <tt>options = {}</tt> then <tt>builder.to_xml</tt> would produce:
+  
+  <?xml version="1.0"?>
+  <Doc>
+    <One>default value</One>
+  </Doc>
+
+If <tt>options = {:One => "BOOM", :Two => "BAMO"}</tt> then <tt>builder.to_xml</tt> would produce:
+
+  <?xml version="1.0"?>
+  <Doc>
+    <One>BOOM</One>
+    <Two>BAMO</Two>
+  </Doc>
+  
+===ATTRIBUTES
+
+You can pass in attributes to the nokobuilder the same way you would with nokogiri builder.
+
+    builder = NokoBuilder.new(options) do |xml|
+      xml.One('xmlns' => 'http://stuff') do
+        xml.Inside "namey", :attribute => "me"
+        xml.Another(:one => "one", :two => "two")
+      end
+    end
+
+If <tt>options = {}</tt> then <tt>builder.to_xml</tt> Would produce:
+
+  <?xml version="1.0"?>
+  <One xmlns="http://stuff">
+    <Inside attribute="me">namey</Inside>
+    <Another one="one" two="two"/>
+  </One>
+  
+If <tt>options = {:Inside_nattr => {:blamo => "one"}, :Another_nattr => {:one => 'new', :three => "thr"}}</tt> then <tt>builder.to_xml</tt> Would produce:
+
+    <?xml version="1.0"?>
+    <One xmlns="http://stuff">
+      <Inside attribute="me" blamo="one">namey</Inside>
+      <Another one="new" two="two" three="thr"/>
+    </One>
+
+===NOKOGIRI OPTIONS
+
+You can pass in options to the nokogiri builder as the second argument if you want.
+
+  builder = NokoBuilder.new({},{:encoding => 'UTF-8'}) do |xml|
+    xml.One do
+      xml.Inside "namey"
+    end
+  end
+
+Doing <tt>builder.to_xml</tt> Would produce:
+
+  <?xml version="1.0" encoding="UTF-8"?>
+  <One>
+    <Inside>namey</Inside>
+  </One>
+  
+== Contributing to noko_builder
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 frausto. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "noko_builder"
+  gem.homepage = "http://github.com/frausto/noko_builder"
+  gem.license = "MIT"
+  gem.summary = %Q{a gem to make building out xmls with nokogiri easier}
+  gem.description = %Q{a gem that lets you add overwriteable values and attributes to the xmls you build}
+  gem.email = "nrfrausto@gmail.com"
+  gem.authors = ["frausto"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "noko_builder #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/noko_builder.rb

@@ -0,0 +1,45 @@
+require 'nokogiri'
+require 'active_support/all'
+
+class NokoBuilder
+  attr_reader :noko
+  delegate *(Nokogiri::XML::Builder.new.methods - Object.new.methods), :to => :noko
+  
+  def initialize(overwrite={}, noko_options={})
+    @overwrite = overwrite
+    @noko = Nokogiri::XML::Builder.new(noko_options) do |xml|
+      @xml = xml
+      yield self
+    end
+  end
+  
+  def method_missing(id, *args, &block)
+    args = update_value(id, args)
+    args = update_attributes(id, args)
+    args = args.compact.reject(&:blank?)
+    
+    @xml.send(id, *args, &block) if args.present? || block.present?
+  end
+  
+  private
+  
+  def update_value(id, args)
+    first_arg = args.shift
+    value = @overwrite[id.to_sym]
+    
+    if value.present?
+      first_arg = first_arg.kind_of?(Hash) ? [value, first_arg] : [value]
+    end
+    
+    [first_arg].flatten + args
+  end
+  
+  def update_attributes(id, args)
+    attributes = @overwrite["#{id}_nattr".to_sym]
+    return args unless attributes.present?
+    
+    args.map do |arg|
+      arg.kind_of?(Hash) ? arg.merge(attributes) : arg
+    end
+  end
+end

data/spec/noko_builder_spec.rb

@@ -0,0 +1,161 @@
+require 'spec_helper'
+
+describe NokoBuilder do
+  describe "element value" do
+    it "should builder xml using the default values" do
+      builder = NokoBuilder.new do |xml|
+        xml.Sup "yo dawg"
+      end
+    
+      builder.doc.xpath("//Sup").text.should == "yo dawg"
+    end
+  
+    it "should overwrite defaults if specified" do
+      builder = NokoBuilder.new(:Sup => "cool story") do |xml|
+        xml.Sup "yo dawg"
+      end
+    
+      builder.doc.xpath("//Sup").text.should == "cool story"
+    end
+  
+    it "should use tag value even if there is no default specified" do
+      builder = NokoBuilder.new(:Sup => "what up") do |xml|
+        xml.Sup
+      end
+    
+      builder.doc.xpath("//Sup").text.should == "what up"
+    end
+  
+    it "should work with nested xml" do
+      builder = NokoBuilder.new(:Two => "what up") do |xml|
+        xml.Outside do
+          xml.One "first"
+          xml.Two "second"
+        end
+      end
+    
+      builder.doc.xpath("//One").text.should == "first"
+      builder.doc.xpath("//Two").text.should == "what up"
+    end
+  
+    it "should not include tag if not set and no defaults" do
+      builder = NokoBuilder.new do |xml|
+        xml.One
+      end
+    
+      builder.to_xml.should_not =~ /One/
+    end
+  
+    it "should work with namespacing" do
+      builder = NokoBuilder.new do |xml|
+        xml.One('xmlns' => 'http://stuff') do
+          xml.Inside "namey"
+        end
+      end
+    
+      builder.doc.xpath("//ns:Inside", "ns" => "http://stuff").text.should == "namey"
+    end
+  
+    it "should be able to pass options to nokogiri builder" do
+      builder = NokoBuilder.new({},{:encoding => 'UTF-8'}) do |xml|
+        xml.One('xmlns' => 'http://stuff') do
+          xml.Inside "namey"
+        end
+      end
+
+      builder.to_xml.should =~ /\<\?xml version="1.0" encoding="UTF-8"\?\>/
+    end
+  end
+  
+  describe "attributes" do
+    it "should work normally like nokogiri builder with attributes" do
+      builder = NokoBuilder.new do |xml|
+        xml.Outside do
+          xml.One "no def", :attr => "cool"
+        end
+      end
+
+      builder.doc.xpath("//One").attr('attr').text.should == "cool"
+    end
+
+    it "should keep attributes even if text value is being overwritten" do
+      builder = NokoBuilder.new(:One => "over") do |xml|
+        xml.Outside do
+          xml.One "no def", :attr => "cool"
+        end
+      end
+
+      builder.doc.xpath("//One").text.should == "over"
+      builder.doc.xpath("//One").attr('attr').text.should == "cool"
+    end
+    
+    it "should keep attributes even if text value is being overwritten from blank" do
+      builder = NokoBuilder.new(:One => "over") do |xml|
+        xml.Outside do
+          xml.One :attr => "cool"
+        end
+      end
+
+      builder.doc.xpath("//One").text.should == "over"
+      builder.doc.xpath("//One").attr('attr').text.should == "cool"
+    end
+    
+    it "should overwrite attributes" do
+      builder = NokoBuilder.new(:One_nattr => {:another => 'awesome'}) do |xml|
+        xml.Outside do
+          xml.One :attr => "cool", :another => "beans"
+        end
+      end
+
+      builder.doc.xpath("//One").attr('attr').text.should == "cool"
+      builder.doc.xpath("//One").attr('another').text.should == "awesome"
+    end
+    
+    it "should add attributes" do
+      builder = NokoBuilder.new(:One_nattr => {:another => 'awesome', :newone => 'new'}) do |xml|
+        xml.Outside do
+          xml.One :another => "beans"
+        end
+      end
+
+      builder.doc.xpath("//One").attr('newone').text.should == "new"
+      builder.doc.xpath("//One").attr('another').text.should == "awesome"
+    end
+    
+    it "should overwrite attributes and value" do
+      builder = NokoBuilder.new(:One => "test", :One_nattr => {:another => 'awesome'}) do |xml|
+        xml.Outside do
+          xml.One :attr => "cool", :another => "beans"
+        end
+      end
+
+      builder.doc.xpath("//One").attr('attr').text.should == "cool"
+      builder.doc.xpath("//One").attr('another').text.should == "awesome"
+      builder.doc.xpath("//One").text.should == "test"
+    end
+    
+    it "should overwrite attributes and value when having a default value" do
+      builder = NokoBuilder.new(:One => "test", :One_nattr => {:another => 'awesome'}) do |xml|
+        xml.Outside do
+          xml.One "testinit", :attr => "cool", :another => "beans"
+        end
+      end
+
+      builder.doc.xpath("//One").attr('attr').text.should == "cool"
+      builder.doc.xpath("//One").attr('another').text.should == "awesome"
+      builder.doc.xpath("//One").text.should == "test"
+    end
+
+    it "should overwrite attributes when having a default value" do
+      builder = NokoBuilder.new(:One_nattr => {:another => 'awesome'}) do |xml|
+        xml.Outside do
+          xml.One "def", :attr => "cool", :another => "beans"
+        end
+      end
+
+      builder.doc.xpath("//One").attr('attr').text.should == "cool"
+      builder.doc.xpath("//One").attr('another').text.should == "awesome"
+      builder.doc.xpath("//One").text.should == "def"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'noko_builder'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification 
+name: noko_builder
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- frausto
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.12"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+description: a gem that lets you add overwriteable values and attributes to the xmls you build
+email: nrfrausto@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/noko_builder.rb
+- spec/noko_builder_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/frausto/noko_builder
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 175878911612147478
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: a gem to make building out xmls with nokogiri easier
+test_files: []
+