graft 0.2.1 → 0.3.0

metadata

@@ -1,123 +1,50 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: graft
-version: !ruby/object:Gem::Version 
-  version: 0.2.1
+version: !ruby/object:Gem::Version
+  version: 0.3.0
 platform: ruby
-authors: 
-- Patrick Reagan
+authors:
+- Loic Nageleisen
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-01-25 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hpricot
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.6.164
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: tzinfo
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.3.12
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: builder
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.1.2
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: activesupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "2.0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: json
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.1.7
-    version: 
-description: 
-email: reaganpr@gmail.com
+date: 2024-05-17 00:00:00.000000000 Z
+dependencies: []
+description: Vendor-independent collaborative hooking library for Ruby
+email: loic.nageleisen@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.rdoc
-files: 
-- README.rdoc
-- Rakefile
-- lib/graft/core_ext/hash.rb
-- lib/graft/json/attribute.rb
-- lib/graft/json/model.rb
-- lib/graft/json.rb
-- lib/graft/model.rb
-- lib/graft/version.rb
-- lib/graft/xml/attribute.rb
-- lib/graft/xml/model.rb
-- lib/graft/xml/type.rb
-- lib/graft/xml.rb
-- test/test_helper.rb
-- test/unit/core_ext/hash_test.rb
-- test/unit/json/attribute_test.rb
-- test/unit/json/model_test.rb
-- test/unit/xml/attribute_test.rb
-- test/unit/xml/model_test.rb
-- test/unit/xml/type_test.rb
-has_rdoc: true
-homepage: http://sneaq.net/
-licenses: []
-
+extra_rdoc_files: []
+files:
+- lib/graft.rb
+- lib/graft/callback.rb
+- lib/graft/hook.rb
+- lib/graft/hook_point.rb
+- lib/graft/stack.rb
+homepage: https://rubygems.org/gems/graft
+licenses:
+- BSD-3-Clause
+- Apache-2.0
+metadata:
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/DataDog/graft-rb
 post_install_message: 
-rdoc_options: 
-- --main
-- README.rdoc
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+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: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 3.4.19
 signing_key: 
-specification_version: 3
-summary: Graft provides an easy way to map XML and JSON data onto your Ruby classes
+specification_version: 4
+summary: Standardised hook interface
 test_files: []
-

data/README.rdoc

@@ -1,138 +0,0 @@
-= Graft
-
-== Description
-
-Graft provides an easy way to map XML and JSON data onto your Ruby classes.
-
-== Installation
-
-Stable:
-
-    $ sudo gem install graft
-    
-Bleeding edge:
-
-    $ git clone git://github.com/reagent/graft.git
-    $ cd graft && rake gem
-    $ sudo gem install pkg/graft-<version>.gem
-
-== Usage
-
-When interacting with APIs, it's quite often the case that the data returned as
-part of the response is represented either as XML or JSON.  The Graft library makes
-turning that data into Ruby objects pretty simple.  This code was an extraction from
-my work on both the Fleakr[http://reagent.github.com/fleakr] and 
-Etsy[http://github.com/reagent/etsy] gems.
-
-=== Mapping XML
-
-If you want to use Graft in XML mode, you'll need to include the right library:
-
-    require 'rubygems'
-    require 'graft/xml'
-
-Once that is set up, you can take an XML string like this:
-
-    <rsp>
-      <user nsid="3">reagent</user>
-      <name>Patrick Reagan</name>
-    </rsp>
-
-And map it onto a Ruby class:
-
-    class User
-      include Graft
-
-      attribute :name  
-      attribute :username, :from => 'user'
-      attribute :id, :from => 'user@nsid', :type => :integer
-    end
-    
-There are a couple of ways to pull this data into the +User+ object.  The simplest
-is from the constructor:
-
-    user = User.new(xml)
-    
-There is also a +populate_from+ instance method that will do the same:
-
-    user = User.new
-    user.populate_from(xml)
-    
-This second method is useful if the data you want in your Ruby object comes from 2
-separate XML files.  Accessing it is simple:
-
-    >> user.name      # => "Patrick Reagan"
-    >> user.username  # => "reagent"
-    >> user.id        # => 3
-
-=== Mapping JSON
-
-The process of mapping JSON is similar to XML, except:
-
-* You don't need to declare the type of the attribute
-* You need to provide a full path to the JSON value
-
-To get started, include the correct library:
-
-    require 'rubygems'
-    require 'graft/json'
-    
-Then for simple JSON data:
-
-    {
-        "rsp": {
-            "user_id": 3,
-            "username": "reagent",
-            "name": "Patrick Reagan"
-        }
-    }
-
-You can map it in a similar way:
-
-    class User
-      include Graft
-  
-      attribute :name, :from => 'rsp/name'
-      attribute :username, :from => 'rsp/username'
-      attribute :id, :from => 'rsp/user_id'
-    end
-
-Again, you can initialize the values from both the constructor:
-
-    user = User.new(json)
-    
-Or the +populate_from+ method:
-
-    user = User.new
-    user.populate_from(json)
-    
-The results are the same:
-
-    >> user.name      # => "Patrick Reagan"
-    >> user.username  # => "reagent"
-    >> user.id        # => 3
-
-== License
-
-Copyright (c) 2009 Patrick Reagan (reaganpr@gmail.com)
-
-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/Rakefile

@@ -1,43 +0,0 @@
-require 'rubygems'
-require 'rake/gempackagetask'
-require 'rake/testtask'
-
-require 'lib/graft/version'
-
-task :default => :test
-
-spec = Gem::Specification.new do |s|
-  s.name             = 'graft'
-  s.version          = Graft::Version.to_s
-  s.has_rdoc         = true
-  s.extra_rdoc_files = %w(README.rdoc)
-  s.rdoc_options     = %w(--main README.rdoc)
-  s.summary          = "Graft provides an easy way to map XML and JSON data onto your Ruby classes"
-  s.author           = 'Patrick Reagan'
-  s.email            = 'reaganpr@gmail.com'
-  s.homepage         = 'http://sneaq.net/'
-  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib,test}/**/*")
-  
-  s.add_dependency('hpricot', '>= 0.6.164')
-  s.add_dependency('tzinfo', '>= 0.3.12')
-  s.add_dependency('builder', '>= 2.1.2')
-  s.add_dependency('activesupport', '>= 2.0')
-  s.add_dependency('json', '>= 1.1.7')
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.gem_spec = spec
-end
-
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = FileList["test/**/*_test.rb"]
-  t.verbose = true
-end
-
-desc 'Generate the gemspec to serve this Gem from Github'
-task :github do
-  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
-  File.open(file, 'w') {|f| f << spec.to_ruby }
-  puts "Created gemspec: #{file}"
-end

data/lib/graft/core_ext/hash.rb

@@ -1,9 +0,0 @@
-class Hash
-  
-  def /(path)
-    path.to_s.split('/').inject(self) do |data, key|
-      (data.is_a?(Hash) && data[key]) ? data[key] : nil
-    end
-  end
-  
-end

data/lib/graft/json/attribute.rb

@@ -1,18 +0,0 @@
-module Graft
-  module Json
-    class Attribute
-
-      attr_reader :name, :source
-
-      def initialize(name, source = nil)
-        @name   = name
-        @source = source.nil? ? @name.to_s : source
-      end
-
-      def value_from(data)
-        data/source
-      end
-
-    end
-  end
-end

data/lib/graft/json/model.rb

@@ -1,28 +0,0 @@
-module Graft
-  module Json
-    module Model
-
-      module ClassMethods
-
-        def attribute(name, options = {})
-          source = options[:from]
-
-          self.attributes << Graft::Json::Attribute.new(name, source)
-          class_eval "attr_accessor :#{name}"
-        end
-        
-        def data_from(json_or_hash)
-          json_or_hash.is_a?(String) ? JSON.parse(json_or_hash) : json_or_hash
-        end
-
-      end
-
-      def self.included(other)
-        other.send(:extend, Graft::Model::ClassMethods)
-        other.send(:extend, Graft::Json::Model::ClassMethods)
-        other.send(:include, Graft::Model::InstanceMethods)
-      end
-
-    end
-  end
-end

data/lib/graft/json.rb

@@ -1,14 +0,0 @@
-$:.unshift File.dirname(__FILE__) + '/..'
-
-require 'json'
-require 'graft/core_ext/hash'
-
-require 'graft/model'
-require 'graft/json/attribute'
-require 'graft/json/model'
-
-module Graft
-  def self.included(other)
-    other.send(:include, Graft::Json::Model)
-  end
-end

data/lib/graft/model.rb

@@ -1,39 +0,0 @@
-module Graft
-  module Model
-
-    module ClassMethods
-      def attributes
-        @attributes ||= []
-      end
-      
-      def collection_from(data_source, node)
-        (data_from(data_source)/node).map {|n| new n }
-      end
-    end
-
-    module InstanceMethods
-      
-      def initialize(source_data = nil)
-        self.source_data = source_data
-        self.populate_from(self.source_data) unless self.source_data.nil?
-      end
-      
-      def source_data=(source_data)
-        @source_data = self.class.data_from(source_data)
-      end
-      
-      def source_data
-        @source_data
-      end
-      
-      def populate_from(data_source)
-        self.class.attributes.each do |attribute|
-          value = attribute.value_from(self.class.data_from(data_source))
-          self.send("#{attribute.name}=".to_sym, value) unless value.nil?
-        end
-      end
-      
-    end
-    
-  end
-end

data/lib/graft/version.rb

@@ -1,13 +0,0 @@
-module Graft
-  module Version
-    
-    MAJOR = 0
-    MINOR = 2
-    TINY  = 1
-    
-    def self.to_s # :nodoc:
-      [MAJOR, MINOR, TINY].join('.')
-    end
-    
-  end
-end

data/lib/graft/xml/attribute.rb

@@ -1,55 +0,0 @@
-module Graft
-  module Xml
-    class Attribute
-
-      # TODO: Refactor the location / attribute logic into a Source class
-
-      attr_reader :name, :sources
-
-      def initialize(name, type = :string, sources = nil)
-        @name = name.to_sym
-        @type = type
-
-        @sources = Array(sources)
-        @sources << @name.to_s if @sources.empty?
-      end
-
-      def type_class
-        "Graft::Xml::Type::#{@type.to_s.camelize}".constantize
-      end
-
-      def split(source)
-        location, attribute = source.split('@')
-        location = self.name.to_s if location.blank?
-
-        [location, attribute]
-      end
-
-      def node_for(document, source)
-        document.at(location(source)) || document.search("//[@#{attribute(source)}]").first
-      end
-
-      def attribute(source)
-        location, attribute = source.split('@')
-        attribute || location
-      end
-
-      def location(source)
-        split(source).first
-      end
-
-      def value_from(document)
-        values = sources.map do |source|
-          node = node_for(document, source)
-          if !node.nil?
-            possible_values = [node.attributes[attribute(source)], node.inner_text]
-            possible_values.detect {|value| !value.blank? }
-          end
-        end
-
-        type_class.new(values.compact.first).value
-      end
-
-    end
-  end
-end

data/lib/graft/xml/model.rb

@@ -1,49 +0,0 @@
-module Graft
-  module Xml
-    module Model
-
-      module ClassMethods
-
-        def attribute(name, options = {})
-          source = options[:from]
-          type   = options[:type] || :string
-
-          self.attributes << Graft::Xml::Attribute.new(name, type, source)
-          class_eval "attr_accessor :#{name}"
-        end
-
-        def data_from(xml_or_document)
-          xml_or_document.is_a?(String) ? Hpricot.XML(xml_or_document) : xml_or_document
-        end
-
-      end
-
-      module InstanceMethods
-
-        def to_hash
-          self.class.attributes.inject({}) {|h,a| h.merge(a.name.to_s => send(a.name)) }
-        end
-
-        def to_xml(tag_name)
-          xml = Builder::XmlMarkup.new
-          xml.instruct!
-          xml.tag! tag_name do
-            to_hash.each do |attribute, value|
-              xml.tag! attribute, value
-            end
-          end
-          xml.target!
-        end
-
-      end
-
-      def self.included(other)
-        other.send(:extend, Graft::Model::ClassMethods)
-        other.send(:extend, Graft::Xml::Model::ClassMethods)
-        other.send(:include, Graft::Model::InstanceMethods)
-        other.send(:include, Graft::Xml::Model::InstanceMethods)
-      end
-
-    end
-  end
-end

data/lib/graft/xml/type.rb

@@ -1,91 +0,0 @@
-module Graft
-  module Xml
-
-    # = Type
-    #
-    class Type
-
-      class ConversionError < StandardError; end
-
-      def initialize(source)
-        @source = source
-      end
-
-      def convertible?
-        true
-      end
-
-      def value
-        raise ConversionError unless (@source.blank? || convertible?)
-        @source.blank? ? nil : convert
-      end
-
-      # = String
-      #
-      class String < Type
-
-        def convert
-          @source
-        end
-
-      end
-
-      # = Boolean
-      #
-      class Boolean < Type
-        def true_values
-          ['true', '1']
-        end
-
-        def false_values
-          ['false', '0']
-        end
-
-        def convertible?
-          (true_values + false_values).include?(@source)
-        end
-
-        def convert
-          true_values.include?(@source) ? true : false
-        end
-      end
-
-      # = Integer
-      #
-      class Integer < Type
-        def convertible?
-          !@source.match(/\d+/).nil?
-        end
-
-        def convert
-          @source.to_i
-        end
-      end
-
-      # = Time
-      #
-      class Time < Type
-
-        def timestamp?
-          !@source.match(/^\d+$/).nil?
-        end
-
-        def convert
-          timestamp? ? ::Time.at(@source.to_i) : ::Time.parse(@source)
-        end
-
-      end
-
-      # = Date
-      #
-      class Date < Type
-
-        def convert
-          ::Date.parse(@source)
-        end
-
-      end
-
-    end
-  end
-end

data/lib/graft/xml.rb

@@ -1,27 +0,0 @@
-$:.unshift File.dirname(__FILE__) + '/..'
-
-require 'hpricot'
-require 'builder'
-require 'tzinfo'
-
-begin
-  # ActiveSupport < 2.3.5
-  require 'active_support/core_ext/blank'
-rescue NameError
-  # ActiveSupport >= 2.3.5 will raise a NameError exception
-  require 'active_support/core_ext/object/blank'
-end
-
-require 'active_support/time_with_zone'
-require 'active_support/inflector'
-
-require 'graft/model'
-require 'graft/xml/type'
-require 'graft/xml/attribute'
-require 'graft/xml/model'
-
-module Graft
-  def self.included(other)
-    other.send(:include, Graft::Xml::Model)
-  end
-end