RubyGems - html_page - Versions diffs - 0.1.0 - Mend

html_page 0.1.0

Files changed (17) hide show

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2e4cad9f888b905848ffa113eab69037aa19da0
+  data.tar.gz: 56c9fde8d11916ad42d40d92ec114139274b7f3f
+SHA512:
+  metadata.gz: 8fabdca47bdf62778aa10f05fa4dd50cfc438f7bcc967bad1b7b7fcda99d3961f37632cd5f6972d257aab4f1b01a357a2e854759bacd0a0adb6bccb304574c8c
+  data.tar.gz: fc5bc10d55847ff0ec21b968bd8832130f96e7a91fdd22836ebbd44e0df91b59c95e1fcb6ec20c4f6f645fb7534ed0302e0d67adec9d52442825ca569865d1da

data/.gitignore ADDED

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

data/.rspec ADDED

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

data/.travis.yml ADDED

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md ADDED

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile ADDED

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

data/LICENSE.txt ADDED

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) 2015 Sean Doyle
+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 ADDED

@@ -0,0 +1,107 @@
+# HtmlPage
+Inject content into an existing HTML document.
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem "html_page"
+```
+And then execute:
+```bash
+$ bundle install
+```
+Or install it yourself as:
+```bash
+$ gem install html_page
+```
+## Usage
+This gem simplifies injecting content into an existing HTML document.
+Given an HTML document as a string, `HtmlPage::Renderer` can inject strings of
+content into the `<head>` and `<body>`:
+```rb
+renderer = HtmlPage::Renderer.new(
+  content: "<html><head></head><body></body></html>",
+  head: "<title>Appended to the head!</title>",
+  body: "<h1>Appended to the body!</h1>",
+)
+renderer.render #=> "<html><head><title>Appended to the head!</title></head><body><h1>Appended to the body</h1></body></html>"
+```
+The gem also includes the `HtmlPage::Capture` class.
+Given a Rails helpers as a `context` along with a block, the `Capture` class
+simplifies appending content captured from a Rails view into the HTML's `<head>`
+and `<body>` tags.
+For example, given the `render_html_with_modifications` defined as:
+```rb
+require "html_page/capture"
+module MyRailsHelper
+  def render_html_with_modifications(html_page_as_string, &block)
+    capturer = HtmlPage::Capture.new(self, &block)
+    head, body = capturer.capture
+    renderer = HtmlPage::Renderer.new(
+      content: html_page_as_string,
+      head: head,
+      body: body,
+    )
+    render inline: renderer.render
+  end
+end
+```
+The rendered HTML page will include content captured with from the view:
+```erb
+<%= render_html_with_modifications @html_page_as_string do %>
+  <title>
+    Without a block argument,
+    the contents of the block will be appended to the `head` element
+  </title>
+<% end %>
+<%= render_html_with_modifications @html_page_as_string do |head| %>
+  <% head.append do %>
+    <title>A single argument, yields the `head1</title>
+  <% end %>
+<% end %>
+<%= render_html_with_modifications @html_page_as_string do |head, body| %>
+  <% head.append do %>
+    <title>Both the `head1 and `body` can be yielded</title>
+  <% 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/[USERNAME]/html_page. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile ADDED

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

data/bin/console ADDED

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "html_page"
+# 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 ADDED

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

data/html_page.gemspec ADDED

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "html_page/version"
+Gem::Specification.new do |spec|
+  spec.name          = "html_page"
+  spec.version       = HtmlPage::VERSION
+  spec.authors       = ["Sean Doyle"]
+  spec.email         = ["sean.p.doyle24@gmail.com"]
+  spec.summary       = %q{Inject content into an existing HTML document.}
+  spec.description   = %q{Inject content into an existing HTML document.}
+  spec.homepage      = "https://github.com/seanpdoyle/html_page"
+  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.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/html_page.rb ADDED

@@ -0,0 +1,6 @@
+require "html_page/version"
+require "html_page/renderer"
+require "html_page/capture"
+module HtmlPage
+end

data/lib/html_page/capture.rb ADDED

@@ -0,0 +1,77 @@
+module HtmlPage
+  class Capture
+    def initialize(context, &block)
+      @context = context
+      @block = block || NullBlock.new
+    end
+    def capture
+      if block.arity > 0
+        block.call(*block_arguments)
+      end
+      [head.content, body.content]
+    end
+    private
+    attr_reader :block, :context
+    def block_arguments
+      [head, body].first(block.arity)
+    end
+    def body
+      @body ||= Block.new(context)
+    end
+    def head
+      @head ||= begin
+        if block.arity < 1
+          BlockWithoutArguments.new(context, &block)
+        else
+          Block.new(context)
+        end
+      end
+    end
+    class BlockWithoutArguments
+      def initialize(context, &block)
+        @context = context
+        @block = block
+      end
+      def content
+        @context.with_output_buffer(&@block)
+      end
+    end
+    private_constant :BlockWithoutArguments
+    class Block
+      def initialize(context)
+        @context = context
+        @content = []
+      end
+      def append(&block)
+        @content.push(@context.with_output_buffer(&block))
+        nil
+      end
+      def content
+        @content.join
+      end
+    end
+    private_constant :Block
+    class NullBlock
+      def arity
+        1
+      end
+      def call(*)
+      end
+    end
+    private_constant :NullBlock
+  end
+end

data/lib/html_page/renderer.rb ADDED

@@ -0,0 +1,49 @@
+module HtmlPage
+  class Renderer
+    def initialize(content:, head: "", body: "")
+      @content = content
+      @head = head
+      @body = body
+    end
+    def render
+      if has_head_tag?
+        insert_head_content
+      end
+      if has_body_tag?
+        insert_body_content
+      end
+      content
+    end
+    private
+    attr_reader :content
+    def has_head_tag?
+      head_tag_index >= 0
+    end
+    def has_body_tag?
+      body_tag_index >= 0
+    end
+    def insert_head_content
+      content.insert(head_tag_index, @head.to_s)
+    end
+    def insert_body_content
+      content.insert(body_tag_index, @body.to_s)
+    end
+    def head_tag_index
+      content.index("</head") || -1
+    end
+    def body_tag_index
+      content.index("</body") || -1
+    end
+  end
+end

data/lib/html_page/version.rb ADDED

@@ -0,0 +1,3 @@
+module HtmlPage
+  VERSION = "0.1.0"
+end

metadata ADDED

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: html_page
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sean Doyle
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2015-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Inject content into an existing HTML document.
+email:
+- sean.p.doyle24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- html_page.gemspec
+- lib/html_page.rb
+- lib/html_page/capture.rb
+- lib/html_page/renderer.rb
+- lib/html_page/version.rb
+homepage: https://github.com/seanpdoyle/html_page
+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.5.0
+signing_key:
+specification_version: 4
+summary: Inject content into an existing HTML document.
+test_files: []
+has_rdoc: