static_resource 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Nick Zalabak
+
+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

@@ -0,0 +1,41 @@
+= static_resource
+
+== Description
+
+A plugin that leverages the slick XML parsing into objects of ActiveResource without
+making any network calls by reading XML documents on your local filesystem.
+The XML documents must conform to the same ActiveResource "schema" rules in order to be
+read and digested into objects.
+
+This is great for those who don't want to store data structures that aren't necessarily
+large enough to be worth storing in the database, but not small enough to "hard code"
+elsewhere.
+
+== Installation
+
+  ruby script/plugin install git://github.com/techwhizbang/static_resource.git
+
+== Usage
+
+#Define an XML file somewhere within your stack, and reference it in a subclass of StaticResource
+#like this:
+
+class Country < StaticResource::Base
+  self.static_resource = File.expand_path(File.dirname(__FILE__) + "/country.xml")
+end
+
+#Use the find method to read the XML file
+country = Country.find(:one)
+
+#Use the object just like you would with attributes on an ActiveResource
+states = country.states
+state = states.first
+
+#Or don't subclass at all just use StaticResource::Base in the raw
+
+static_resource = StaticResource::Base.find(:one, :from => Rails.root + "/lib/whatever.xml")
+
+=== Other
+
+Problems, comments, and suggestions all welcome. nick@controlaltcreate.com or visit my blog
+http://techwhizbang.com

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rake'
+require 'rake/testtask'
+ 
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "static_resource"
+    s.summary = "A gem that leverages the XML parsing of ActiveResource into objects without making any network calls"
+    s.description = "Leverages the XML parsing of ActiveResource into objects without making any network calls by reading XML documents on your local filesystem"
+    s.email = "techwhizbang@gmail.com"
+    s.homepage = "http://github.com/techwhizbang/static_resource"
+    s.rubyforge_project = 'static_resource'
+    s.authors = ["Nick Zalabak"]
+    s.add_development_dependency "mocha"
+    s.files =  FileList["[A-Za-z]*", "{lib,test}/**/*"]
+    s.test_files = FileList["test/**/*"]
+    s.add_dependency "activeresource"
+  end
+ 
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+ 
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+ 
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/init.rb

@@ -0,0 +1,2 @@
+require 'active_resource'
+require 'static_resource'

data/lib/static_resource.rb

@@ -0,0 +1,68 @@
+module StaticResource
+  class Base < ::ActiveResource::Base
+  
+    self.site = ""
+
+    class << self
+
+      def static_resource
+        if defined?(@static_resource)
+          @static_resource
+        elsif superclass != Object && superclass.static_resource
+          superclass.static_resource.dup.freeze
+        end
+      end
+    
+      def static_resource=(static_resource)
+        if static_resource.nil?
+          @static_resource = nil
+        else
+          @static_resource = static_resource
+        end
+      end
+
+      def find(*arguments)
+        scope   = arguments.slice!(0)
+        options = arguments.slice!(0) || {}
+        options = { :from => @static_resource }.merge(options)
+        if scope == :all  
+          resource = find_every(options)
+          if options[:id] && options[:key]
+            resource = resource.detect { |r| r.send(options[:key].to_sym) == options[:id] }
+          end
+        elsif scope == :first
+          resource = find_every(options).first
+        elsif scope == :last
+          resource= find_every(options).last
+        elsif scope == :one
+          resource = find_one(options)
+        else
+          resource = find_single(scope, options)
+        end
+ 
+        resource = resource.attributes[options[:id]] if scope != :all && options[:id] 
+        resource
+      end
+
+      def connection(refresh = false)
+        Connection.new(ActiveResource::Formats[:xml])
+      end
+    end
+  end
+
+  class Connection < ::ActiveResource::Connection
+    def initialize(format = ActiveResource::Formats[:xml])
+      self.format = format
+    end
+
+    def get(path, headers = {})
+      format.decode(request(:get, path, nil))
+    end
+
+    private
+
+    def request(method, path, *arguments)
+      File.read( path )
+    end
+  end
+end

data/static_resource.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{static_resource}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nick Zalabak"]
+  s.date = %q{2010-03-06}
+  s.description = %q{Leverages the XML parsing of ActiveResource into objects without making any network calls by reading XML documents on your local filesystem}
+  s.email = %q{techwhizbang@gmail.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/static_resource.rb",
+     "static_resource.gemspec",
+     "test/all_tests.rb",
+     "test/country.xml",
+     "test/os.xml",
+     "test/states.xml",
+     "test/static_resource_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/techwhizbang/static_resource}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{static_resource}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A gem that leverages the XML parsing of ActiveResource into objects without making any network calls}
+  s.test_files = [
+    "test/all_tests.rb",
+     "test/country.xml",
+     "test/os.xml",
+     "test/states.xml",
+     "test/static_resource_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_runtime_dependency(%q<activeresource>, [">= 0"])
+    else
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<activeresource>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<activeresource>, [">= 0"])
+  end
+end
+

data/test/all_tests.rb

@@ -0,0 +1 @@
+Dir['**/*_test.rb'].each { |test_case| require test_case }

data/test/country.xml

@@ -0,0 +1,20 @@
+<country>
+    <states type="array">
+        <state>
+            <id type="integer">1</id>
+            <name type="string">Illinois</name>
+            <founded type="datetime">1879-11-06 06:15:00</founded>
+            <latitude type="float">50.2345</latitude>
+            <longitude type="float">123.234</longitude>
+            <population type="integer">100000000</population>
+        </state>
+        <state>
+            <id type="integer">2</id>
+            <name type="string">California</name>
+            <founded type="datetime">1862-01-02 06:15:00</founded>
+            <latitude type="float">70.2345</latitude>
+            <longitude type="float">14.234</longitude>
+            <population type="integer">400000000</population>
+        </state>
+    </states>
+</country>

data/test/os.xml

@@ -0,0 +1,11 @@
+<os>
+    <pc>
+        <description>sucks</description>
+    </pc>
+    <mac>
+        <description>rocks</description>
+    </mac>
+    <linux>
+        <description>love it</description>
+    </linux>
+</os>

data/test/states.xml

@@ -0,0 +1,18 @@
+<states type="array">
+  <state>
+    <id type="integer">1</id>
+    <name type="string">Illinois</name>
+    <founded type="datetime">1879-11-06 06:15:00</founded>
+    <latitude type="float">50.2345</latitude>
+    <longitude type="float">123.234</longitude>
+    <population type="integer">100000000</population>
+  </state>
+  <state>
+    <id type="integer">2</id>
+    <name type="string">California</name>
+    <founded type="datetime">1862-01-02 06:15:00</founded>
+    <latitude type="float">70.2345</latitude>
+    <longitude type="float">14.234</longitude>
+    <population type="integer">400000000</population>
+  </state>
+</states>

data/test/static_resource_test.rb

@@ -0,0 +1,74 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class Country < StaticResource::Base
+  self.static_resource = File.expand_path(File.dirname(__FILE__) + "/country.xml")
+end
+
+class StaticResourceTest < Test::Unit::TestCase
+
+  def test_static_resource_assignment
+    assert_equal(File.expand_path(File.dirname(__FILE__) + "/country.xml"), Country.static_resource)
+  end
+
+  def test_connection_type
+    assert_instance_of(StaticResource::Connection, Country.connection)
+  end
+
+  def test_find_without_xml_file
+    assert_not_nil(Country.find(:one))
+  end
+
+  def test_find_with_xml_file
+    assert_not_nil(StaticResource::Base.find(:one, :from => File.expand_path(File.dirname(__FILE__) + "/os.xml")))
+  end
+
+  def test_find_expects_find_one
+    file = File.expand_path(File.dirname(__FILE__) + "/os.xml")
+    StaticResource::Base.expects(:find_one).with({:from => file})
+    StaticResource::Base.find(:one, :from => file)
+  end
+
+  def test_find_expects_find_all
+    file = File.expand_path(File.dirname(__FILE__) + "/states.xml")
+    StaticResource::Base.expects(:find_every).with({:from => file})
+    StaticResource::Base.find(:all, :from => file)
+  end
+
+  def test_find_expects_find_last
+    file = File.expand_path(File.dirname(__FILE__) + "/states.xml")
+    resource = StaticResource::Base.find(:last, :from => file)
+    assert_equal(resource.attributes["name"], "California")
+  end
+
+  def test_find_expects_find_first
+    file = File.expand_path(File.dirname(__FILE__) + "/states.xml")
+    resource = StaticResource::Base.find(:first, :from => file)
+    assert_equal(resource.attributes["name"], "Illinois")
+  end
+
+  def test_connection_get_method
+    file = File.expand_path(File.dirname(__FILE__) + "/os.xml")
+    connection = StaticResource::Connection.new(ActiveResource::Formats[:xml])
+    connection.format.expects(:decode)
+    connection.get(file, nil)
+  end
+
+  def test_connection_request_expects_file_read
+    file = File.expand_path(File.dirname(__FILE__) + "/os.xml")
+    connection = StaticResource::Connection.new(ActiveResource::Formats[:xml])
+    File.expects(:read).with(file)
+    connection.send(:request, nil, file, nil)
+  end
+
+  def test_find_with_id_lookup
+    file = File.expand_path(File.dirname(__FILE__) + "/os.xml")
+    resource = StaticResource::Base.find(:one, :id => "linux", :from => file)
+    assert_equal(resource.description, "love it")
+  end
+
+  def test_find_all_with_id_and_key_lookup
+    file = File.expand_path(File.dirname(__FILE__) + "/states.xml")
+    resource = StaticResource::Base.find(:all, :id => "Illinois", :key => "name", :from => file)
+    assert_equal(resource.name, "Illinois")
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+require 'rubygems'
+gem 'activeresource'
+require 'active_resource'
+require 'mocha'
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/static_resource")

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: static_resource
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Nick Zalabak
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-06 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Leverages the XML parsing of ActiveResource into objects without making any network calls by reading XML documents on your local filesystem
+email: techwhizbang@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- init.rb
+- lib/static_resource.rb
+- static_resource.gemspec
+- test/all_tests.rb
+- test/country.xml
+- test/os.xml
+- test/states.xml
+- test/static_resource_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/techwhizbang/static_resource
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: static_resource
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A gem that leverages the XML parsing of ActiveResource into objects without making any network calls
+test_files: 
+- test/all_tests.rb
+- test/country.xml
+- test/os.xml
+- test/states.xml
+- test/static_resource_test.rb
+- test/test_helper.rb