nokogiri-cache 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MThmNjkyMTVjYjA0MDgzOWNiOTVjMTc3ZjY2NWFmZGJhNDE1NDNhOA==
+  data.tar.gz: !binary |-
+    ZDk2OWVkM2Y4YWY1MjRkZjcwOWFlNzg5ZTFkY2MyOTgxZDZhYTliYw==
+SHA512:
+  metadata.gz: !binary |-
+    MmI2NDAzOGM4Nzk5YjEwMzExYmE5YWE1NDIzOWNlMjdlNTg4NzFkN2Y3OGYx
+    OTQzZGJjMGNlYTE4MDhkZWIxZjdmZDRlOTU2ZGEzYjUxNmIwOWJkODczMDZi
+    YWRhMGE0ZmJjMzcwNzZkYjg5NTUwMmE0NDlmODlhYmI1ZjkwY2U=
+  data.tar.gz: !binary |-
+    ZGEwOTY0NmFiOTI1OGQ2YWQzOTRlZDZjY2E1NGU2NGIzMjUxN2UwZTQ1OWIy
+    MTIwNWI5NjU1MzE3ZDllYjM5YjE4MjViMmI5MmIxYWViYWU1OWVkYWQ0MjY4
+    YzMyNjM5ZGY2YThiYTA0YmUwOGU5MThiOGMzZWU1MmRlZTczZjE=

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nokogiri-cache.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Daniel Vandersluis
+
+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.md

@@ -0,0 +1,45 @@
+# Nokogiri::Cache
+
+Add fragment caching when using `Nokogiri::XML::Builder` to build XML files in a Rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nokogiri-cache'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nokogiri-cache
+
+## Usage
+
+```ruby
+Nokogiri::XML::Builder.new do |xml|
+  xml.cache 'cache_key' do |xml|
+    xml....
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dvandersluis/nokogiri-cache.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/benchmarks/cache_benchmark.rb

@@ -0,0 +1,73 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'benchmark/ips'
+require 'action_controller'
+require 'nokogiri/cache'
+
+def controller
+  ActionController::Base.new
+end
+public :controller
+
+Benchmark.ips do |x|
+  x.report('uncached') do
+    Nokogiri::XML::Builder.new do |xml|
+      xml.countries do
+        xml.country(name: 'Canada') do
+          xml.languages do
+            xml.language 'English'
+            xml.language 'French'
+          end
+        end
+
+        xml.country(name: 'United States') do
+          xml.abbreviation 'USA'
+        end
+      end
+    end
+  end
+
+  x.report('cached') do
+    ActionController::Base.perform_caching = true
+
+    Nokogiri::XML::Builder.new do |xml|
+      xml.cache 'countries' do |xml|
+        xml.countries do
+          xml.country(name: 'Canada') do
+            xml.languages do
+              xml.language 'English'
+              xml.language 'French'
+            end
+          end
+
+          xml.country(name: 'United States') do
+            xml.abbreviation 'USA'
+          end
+        end
+      end
+    end
+  end
+
+  x.report('Rails.cache disabled') do
+    ActionController::Base.perform_caching = false
+
+    Nokogiri::XML::Builder.new do |xml|
+      xml.cache 'countries' do |xml|
+        xml.countries do
+          xml.country(name: 'Canada') do
+            xml.languages do
+              xml.language 'English'
+              xml.language 'French'
+            end
+          end
+
+          xml.country(name: 'United States') do
+            xml.abbreviation 'USA'
+          end
+        end
+      end
+    end
+  end
+
+  x.compare!
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nokogiri/cache"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nokogiri/cache.rb

@@ -0,0 +1,66 @@
+require "nokogiri/cache/version"
+require 'nokogiri'
+
+module Nokogiri
+  module Cache
+    # Allow nokogiri templates to do fragment caching
+    # We can't just use Rails' built in cache helper because the document is not built as we go along so
+    # the output buffer has no data
+    # Instead, we can override caching to be able to put XML fragments into the cache and pull them out
+    # to be inserted into a document later
+    # NOTE: This code mostly mirrors action_view/helpers/cache_helper.rb
+    def cache(name, options = nil, &block)
+      @context = eval('self', block.binding)
+      controller = @context.controller
+
+      if controller.perform_caching
+        get_fragment(controller, name, options, &block)
+      else
+        yield self
+      end
+    end
+
+  private
+
+    def get_fragment(controller, name, options, &block)
+      if fragment = read_fragment(name, options)
+        self << fragment.strip
+      else
+        # Create an XML fragment to insert the cached XML into
+        # A root node is needed in case there are multiple nodes being inserted at the same level
+        fragment = Nokogiri::XML::Builder.new { |xml| xml.root }
+        Nokogiri::XML::Builder.with(fragment.doc.children.first, &block)
+
+        # Grab the XML within the root node and render it to a string (we don't want to include the root node as it was
+        # just added for processing)
+        xml = fragment.doc.root.children.to_xml(encoding: 'UTF-8', save_with: Nokogiri::XML::Node::SaveOptions::NO_DECLARATION)
+
+        # Save the fragment XML to the cache
+        write_fragment(name, xml, options)
+        self << xml.strip
+      end
+    end
+
+    def read_fragment(key, options)
+      controller.read_fragment(key, options)
+
+    rescue Redis::CannotConnectError, Redis::ConnectionError, Redis::TimeoutError => e
+      handle_cache_error(e)
+      nil
+    end
+
+    def write_fragment(key, value, options)
+      controller.write_fragment(key, value, options)
+
+    rescue Redis::CannotConnectError, Redis::ConnectionError, Redis::TimeoutError => e
+      handle_cache_error(e)
+      nil
+    end
+
+    def handle_cache_error(e)
+      Rails.logger.error 'Cache is not available'
+    end
+  end
+end
+
+Nokogiri::XML::Builder.send(:include, Nokogiri::Cache)

data/lib/nokogiri/cache/version.rb

@@ -0,0 +1,5 @@
+module Nokogiri
+  module Cache
+    VERSION = "1.0.0"
+  end
+end

data/nokogiri-cache.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nokogiri/cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nokogiri-cache'
+  spec.version       = Nokogiri::Cache::VERSION
+  spec.authors       = ['Daniel Vandersluis']
+  spec.email         = ['daniel.vandersluis@gmail.com']
+
+  spec.summary       = %q{Allow Rails to cache fragments of XML built by nokogiri}
+  spec.description   = %q{Allow Rails to cache fragments of XML built by nokogiri}
+  spec.homepage      = 'https://www.github.com/dvandersluis/nokogiri-cache'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'benchmark-ips'
+
+  spec.add_dependency 'rails', '~> 3.0'
+  spec.add_dependency 'nokogiri', '~> 1.6.7'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: nokogiri-cache
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Daniel Vandersluis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  prerelease: false
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  prerelease: false
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+description: Allow Rails to cache fragments of XML built by nokogiri
+email:
+- daniel.vandersluis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmarks/cache_benchmark.rb
+- bin/console
+- bin/setup
+- lib/nokogiri/cache.rb
+- lib/nokogiri/cache/version.rb
+- nokogiri-cache.gemspec
+homepage: https://www.github.com/dvandersluis/nokogiri-cache
+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.1.5
+signing_key: 
+specification_version: 4
+summary: Allow Rails to cache fragments of XML built by nokogiri
+test_files: []
+has_rdoc: