yorinter 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c275d6128aecdefc5591000be7d0165126f463e
-  data.tar.gz: 22fb474826894f39def7492ed8c34d469864ead6
+  metadata.gz: 2460be357739bdbddd9a34fb844d0bf938543b5f
+  data.tar.gz: 2b683055c64747ef4f440a3c3a66f9f23ae9fc97
 SHA512:
-  metadata.gz: 2f69338e77c7ea598b7ee27f79bf8560218381e65e47190f857292d11d1f335e1907147cde03d6f11854303039f265a9cddee88490e44c7c727b5919f9a9f28e
-  data.tar.gz: 97ffb8387c8feb4c0019e73bbc54025d9da24f6b7179189364db3c8cddc4337907007ac4a305111b09ce62837da5d939e5dec722c56c16038be5c29e170d667e
+  metadata.gz: 773150a86e149e1504e6ab3a1bdbb0b8f9d20f97f33012b290083d1297c2e9e3cc9f228602c02ebad1845693d912fd6eadfc422bde6ffd2177619174f39f254c
+  data.tar.gz: b9cb0cae6cb6ec19041d4385919362b2af591062b4d79d14c6d0a88087c2ee9bd623f8342351f792d54bce2fbead3afbd22ead43513de409b59e0b48e07d881b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hailn@topica.edu.vn. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in yorinter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    yorinter (0.1.2)
+      activesupport
+      haml
+      wicked_pdf
+      wkhtmltopdf-binary
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    concurrent-ruby (1.0.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    haml (5.0.4)
+      temple (>= 0.8.0)
+      tilt
+    hashdiff (0.3.7)
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.1)
+    public_suffix (3.0.1)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    safe_yaml (1.0.4)
+    temple (0.8.0)
+    thread_safe (0.3.6)
+    tilt (2.0.8)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+    webmock (3.1.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    wicked_pdf (1.1.0)
+    wkhtmltopdf-binary (0.12.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock (~> 3.1)
+  yorinter!
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Hai Le
+
+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,43 @@
+# Yorinter
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yorinter`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yorinter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yorinter
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/yorinter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Yorinter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/yorinter/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

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

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/yorinter.rb

@@ -0,0 +1,15 @@
+require "haml"
+require "wicked_pdf"
+require "active_support"
+require 'active_support/core_ext'
+
+require "yorinter/version"
+require "yorinter/printable"
+require "yorinter/printable_document"
+require "yorinter/engine"
+require "yorinter/erb_engine"
+require "yorinter/haml_engine"
+require "yorinter/pdf_engine"
+
+module Yorinter
+end

data/lib/yorinter/engine.rb

@@ -0,0 +1,121 @@
+module Yorinter
+  class Engine
+    def initialize document, params = {}, options = {}
+      @document = document
+      @params = params
+      @engine = build_engine
+      @options = options
+    end
+
+    def document_model
+      @document.model || {}
+    end
+
+    def model_endpoint
+      if @document.model_endpoint
+        PrintableDocument.new(
+          template: @document.model_endpoint
+        ).render ErbEngine, @params
+      end
+    end
+
+    # Get model from endpoint
+    def endpoint_model
+      if endpoint = model_endpoint
+        JSON.parse Net::HTTP.get(URI(endpoint))
+      else
+        {}
+      end
+    end
+
+    def model_binding_object
+      model = document_model.deep_merge(endpoint_model)
+      JSON.parse(model.to_json, object_class: OpenStruct)
+    end
+
+    def params_binding_object
+      JSON.parse((@params || {}).to_json, object_class: OpenStruct)
+    end
+
+    def binding_object
+      return @binding_object if @binding_object
+
+      # Use document binding_object if it already has
+      if @document.respond_to?(:binding_object) and @document.binding_object
+        return @binding_object = @document.binding_object
+      end
+
+      this = self
+      helper = @options[:helper]
+
+      helper_wrapper = Object.new
+      helper_wrapper.instance_eval @document.helper.to_s
+
+      @binding_object = Object.new.instance_eval do
+        @model  = this.model_binding_object
+        @params = this.params_binding_object
+
+        # Helper from params
+        extend helper if helper
+
+        # Helper from document
+        helper_wrapper.singleton_class.constants.each do |const|
+          extend helper_wrapper.singleton_class.const_get const
+        end
+
+        def get_binding
+          binding
+        end
+
+        self
+      end
+    end
+
+    def document_options
+      return @document_options if @document_options
+
+      @document_options = (@document.options || {}).deep_symbolize_keys
+
+      # Render title
+      if @document_options[:title]
+        @document_options[:title] = render_partial @document_options[:title]
+      end
+
+      # Render footer content
+      if footer = @document_options[:footer]
+        if footer[:content]
+          footer[:content] = render_partial footer[:content]
+        end
+      end
+
+      @document_options
+    end
+
+    def render_partial template
+      PrintableDocument.new(
+        template: template,
+        binding_object: binding_object
+      ).render ErbEngine, @params
+    end
+
+    # Abstract methods
+    def build_engine
+      raise 'Abstract method'
+    end
+
+    def render
+      raise 'Abstract method'
+    end
+
+    class << self
+      def search_engine input, output
+        (@@engines || {})[[input, output]]
+      end
+
+      def register_engine input, output
+        @@engines ||= {}
+        @@engines[[input, output]] = self
+      end
+    end
+  end
+end

data/lib/yorinter/erb_engine.rb

@@ -0,0 +1,13 @@
+module Yorinter
+  class ErbEngine < Engine
+    register_engine 'erb','html'
+
+    def build_engine
+      ERB.new(@document.template || '')
+    end
+
+    def render
+      @engine.result(binding_object.get_binding)
+    end
+  end
+end

data/lib/yorinter/haml_engine.rb

@@ -0,0 +1,13 @@
+module Yorinter
+  class HamlEngine < Engine
+    register_engine 'haml', 'html'
+
+    def build_engine
+      Haml::Engine.new(@document.template || '')
+    end
+
+    def render
+      @engine.render binding_object
+    end
+  end
+end

data/lib/yorinter/pdf_engine.rb

@@ -0,0 +1,33 @@
+module Yorinter
+  class PdfEngine < Engine
+    def build_engine
+      @engine   = WickedPdf.new
+    end
+  end
+
+  class HtmlToPdfEngine < PdfEngine
+    register_engine 'html', 'pdf'
+
+    def render
+      @engine.pdf_from_string(@document.template, document_options)
+    end
+  end
+
+  class ErbToPdfEngine < PdfEngine
+    register_engine 'erb', 'pdf'
+
+    def render
+      html = ErbEngine.new(@document, @params, @options).render
+      @engine.pdf_from_string(html, document_options)
+    end
+  end
+
+  class HamlToPdfEngine < PdfEngine
+    register_engine 'haml', 'pdf'
+
+    def render
+      html = HamlEngine.new(@document, @params, @options).render
+      @engine.pdf_from_string(html, document_options)
+    end
+  end
+end

data/lib/yorinter/printable.rb

@@ -0,0 +1,17 @@
+module Yorinter
+  DEFAULT_INPUT_FORMAT  = 'erb'
+  DEFAULT_OUTPUT_FORMAT = 'html'
+
+  module Printable
+    def print params = {}, options = {}
+      input_format = self.input_format || DEFAULT_INPUT_FORMAT
+      output_format = params[:format] || self.output_format || DEFAULT_OUTPUT_FORMAT
+
+      engine_class = Engine.search_engine input_format, output_format
+
+      raise 'Not convertable' unless engine_class
+
+      engine = engine_class.new(self, params, options).render
+    end
+  end
+end

data/lib/yorinter/printable_document.rb

@@ -0,0 +1,30 @@
+module Yorinter
+  class PrintableDocument
+    include Yorinter::Printable
+
+    def initialize params = {}
+      [:name, :code, :version, :template, :helper, :style,
+        :model, :model_endpoint, :binding_object,
+        :input_format, :output_format, :options].each do |field|
+        send("#{field}=".to_sym, params[field]) if params[field]
+      end
+    end
+
+    def render engine, params = {}, options = {}
+      engine.new(self, params, options).render
+    end
+
+    attr_accessor :name
+    attr_accessor :code
+    attr_accessor :version
+    attr_accessor :template
+    attr_accessor :helper
+    attr_accessor :style
+    attr_accessor :model
+    attr_accessor :model_endpoint
+    attr_accessor :input_format
+    attr_accessor :output_format
+    attr_accessor :options
+    attr_accessor :binding_object
+  end
+end

data/lib/yorinter/version.rb

@@ -0,0 +1,3 @@
+module Yorinter
+  VERSION = "0.2.2"
+end

data/yorinter.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "yorinter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "yorinter"
+  spec.version       = Yorinter::VERSION
+  spec.authors       = ["Hai Le"]
+  spec.email         = ["hailn@topica.edu.vn"]
+
+  spec.summary       = "Help render document template"
+  spec.description   = "Support render erb or haml to html or pdf, using data from json or from api endpoint"
+  spec.homepage      = "https://git.edumall.io/eden/yorinter"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "https://gemall.edumall.io"
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.1"
+
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'wicked_pdf'
+  spec.add_runtime_dependency 'wkhtmltopdf-binary'
+  spec.add_runtime_dependency 'haml'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yorinter
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Hai Le
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-24 00:00:00.000000000 Z
+date: 2019-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,7 +129,27 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yorinter.rb
+- lib/yorinter/engine.rb
+- lib/yorinter/erb_engine.rb
+- lib/yorinter/haml_engine.rb
+- lib/yorinter/pdf_engine.rb
+- lib/yorinter/printable.rb
+- lib/yorinter/printable_document.rb
+- lib/yorinter/version.rb
+- yorinter.gemspec
 homepage: https://git.edumall.io/eden/yorinter
 licenses:
 - MIT