pixelpress 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 638d9a7486c6de12d194da6ab7265064278f51d4
+  data.tar.gz: a0165b1cc71118c91c6b6a7194abb9bdc11c4f42
+SHA512:
+  metadata.gz: 9d6a844cf997062163e1c546b8e6c2b2303f8340ada3f533bc4452c48fbecb25ce31ea0caefa98fae5905590373e8565ece0eddea5479ab9e1611320d39bc1e0
+  data.tar.gz: eec11694a906bf87489d74fb671f89663e81f8ef8da511fc19b044ea319ae50e817ae777fa460ff7c13602ddafc84bc333913d76c827e287ea291ccbbe40f2ef

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/pixelpress-0.1.0.gem
+
+# rspec failure tracking
+.rspec_status
+/.byebug_history
+/spec/lib/generators/test/generator_spec/test_destination

data/.rspec

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

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pixelpress.gemspec
+gemspec
+
+gem 'activemodel'
+gem 'bundler'
+gem 'pry-byebug'
+gem 'rake'
+gem 'rspec', '~> 3.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Alex
+
+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,93 @@
+# Pixelpress
+[![CircleCI](https://circleci.com/gh/nerdgeschoss/pixelpress/tree/master.svg?style=svg)](https://circleci.com/gh/nerdgeschoss/pixelpress/tree/master)
+
+Modeled after `ActionMailer` this gem allows you to render PDFs from HTML via Rails templating engine. Also you can preview your PDF templates via a supplied engine during development.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pixelpress'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pixelpress
+
+## Usage
+
+Run the printer generator providing the name of your printer with methods to be generated:
+```bash
+rails generate pixelpress:printer NAME [method_name1 method_name2 ...] [options]
+```
+
+This creates an `ApplicationPrinter` in `app/printers` and the corresponding subclass and also mounts the engine in your `config/routes.rb` file.
+
+**Example**
+```bash
+$ rails g pixelpress:printer invoice customer_invoice delivery_document 	
+```
+will generate `app/printers/invoice_printer.rb` file which looks like this:
+```ruby
+class InvoicePrinter < ApplicationPrinter
+ 	def customer_invoice
+ 		# put your code here
+ 	end
+
+ 	def delivery_document
+ 		# put your code here
+ 	end
+end
+```
+
+Also this command will generate the corresponding templates  as `.pdf.erb` files located in `app/views/printers/invoice/`:
+
+- `customer_invoice.pdf.erb`
+- `delivery_document.pdf.erb`
+
+You can preview your documents by running `rails s` and go to
+
+```
+localhost:3000/rails/printers
+```
+
+To use your printers in code, you can instantiate them just like mailers:
+
+```ruby
+InvoicePrinter.customer_invoice.pdf # render a temporary pdf file
+InvoicePrinter.customer_invoice.html # get the rendered document in html format
+```
+
+So you can send them to the client via a controller action:
+
+```ruby
+class InvoicesController < ApplicationController
+  def show
+    document = InvoicePrinter.customer_invoice
+    respond_to do |format|
+      format.html { render html: document.html }
+      format.pdf { send_data document.pdf.read, disposition: 'inline', type: 'application/pdf' }
+    end
+  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/Alex/pixelpress.
+
+
+## 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/app/controllers/pixelpress/printers_controller.rb

@@ -0,0 +1,15 @@
+class Pixelpress::PrintersController < ActionController::Base
+  def index
+    @printers = Pixelpress::Preview.all
+  end
+
+  def show
+    klass = params[:printer_id]
+    method = params[:id]
+    printer = Pixelpress::Preview.all.map { |e| [e.printer_name, e] }.to_h[klass].send(method)
+    respond_to do |format|
+      format.html { render html: printer.html }
+      format.pdf { send_data printer.pdf.read, disposition: 'inline', type: 'application/pdf' }
+    end
+  end
+end

data/app/views/pixelpress/printers/index.html.erb

@@ -0,0 +1,8 @@
+<% @printers.each do |printer| %>
+  <% printer.previews.each do |preview| %>
+    <a href="/rails/printers/<%= printer.printer_name %>/<%= preview.to_s.underscore %>">
+      <%= printer.class.name %>#<%= preview %>
+    </a>
+    <br>
+  <% end %>
+<% end %>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'pixelpress'
+
+# 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/config/routes.rb

@@ -0,0 +1,5 @@
+Pixelpress::Engine.routes.draw do
+  resources :printers, only: [:index] do
+    get ':id', to: 'printers#show'
+  end
+end

data/lib/generators/pixelpress/printer/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a custom printer with the given name.
+
+Example:
+    rails generate pixelpress:printer invoice method_name1 meth_name2
+
+    This will create:
+        app/printers/invoice_printers.rb 

data/lib/generators/pixelpress/printer/printer_generator.rb

@@ -0,0 +1,38 @@
+module Pixelpress
+  module Generators
+    class PrinterGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      argument :passed_methods, type: :array, default: [], required: false, banner: 'method_name1 method_name2 ...'
+
+      check_class_collision suffix: 'Printer'
+
+      hook_for :test_framework
+
+      def create_custom_printer
+        template 'application_printer.rb', 'app/printers/application_printer.rb' unless Rails.root.join('app/printers/application_printer.rb').exist?
+        route 'mount Pixelpress::Engine => "rails" if Rails.env.development?' unless engine_mounted?
+        template 'printer.pdf.erb', 'app/views/layouts/printer.pdf.erb' unless Rails.root.join('app/views/layouts/printer.pdf.erb').exist?
+        template 'printer.rb', File.join('app/printers', class_path, "#{file_name}_printer.rb")
+      end
+
+      def create_custom_printer_views
+        passed_methods.each do |method_name|
+          @method_name = method_name
+          template 'template.pdf.erb', File.join('app/views/printers', class_path, "#{file_name}/#{method_name}.pdf.erb")
+        end
+      end
+
+      private
+
+      def file_name
+        @_file_name ||= super.gsub(/_printer/i, '')
+      end
+
+      def engine_mounted?
+        routes = Rails.root.join('config/routes.rb')
+        routes.exist? && routes.read.include?('Pixelpress::Engine')
+      end
+    end
+  end
+end

data/lib/generators/pixelpress/printer/templates/application_printer.rb

@@ -0,0 +1,3 @@
+class ApplicationPrinter < Pixelpress::Base
+  layout 'printer'
+end

data/lib/generators/pixelpress/printer/templates/initializer.rb

@@ -0,0 +1,2 @@
+Rails.application.config.autoload_paths << Rails.root.join('app', 'printers')
+Rails.application.config.autoload_paths << Rails.root.join('spec', 'printer', 'previews') if Rails.env.development?

data/lib/generators/pixelpress/printer/templates/printer.pdf.erb

@@ -0,0 +1 @@
+<%%= yield %>

data/lib/generators/pixelpress/printer/templates/printer.rb

@@ -0,0 +1,7 @@
+<% module_namespacing do -%>
+class <%= class_name %>Printer < ApplicationPrinter<% passed_methods.each do |m| %>
+  def <%= m %>
+    #put your code here, if you want :)
+  end<% end %>
+end
+<% end -%>

data/lib/generators/pixelpress/printer/templates/template.pdf.erb

@@ -0,0 +1 @@
+<h1>Hello from <%= class_name.classify %>Printer#<%= @method_name %></h1>

data/lib/generators/rspec/printer_generator.rb

@@ -0,0 +1,25 @@
+module Rspec
+  module Generators
+    class PrinterGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      argument :passed_methods, type: :array, default: [], required: false, banner: 'method_name1 method_name2 ...'
+
+      check_class_collision suffix: 'Printer'
+
+      def create_printer_spec
+        template 'printer_spec.rb', File.join('spec/printers', class_path, "#{file_name}_printer_spec.rb")
+      end
+
+      def create_printer_previews
+        template 'preview.rb', File.join('spec/printers/previews', class_path, "#{file_name}_preview.rb")
+      end
+
+      private
+
+      def file_name
+        @_file_name ||= super.gsub(/_printer/i, '')
+      end
+    end
+  end
+end

data/lib/generators/rspec/templates/preview.rb

@@ -0,0 +1,5 @@
+class <%= class_name %>Preview < Pixelpress::Preview<% passed_methods.each do |m| %>
+  def <%= m %>
+    <%= class_name %>Printer.<%= m %>
+  end<% end %>
+end

data/lib/generators/rspec/templates/printer_spec.rb

@@ -0,0 +1,7 @@
+require '<%= File.exists?('spec/rails_helper.rb') ? 'rails_helper' : 'spec_helper' %>'
+
+describe <%= class_name %>Printer, pending: true do
+  it "should be tested" do
+    raise "implement your rspec tests"
+  end
+end

data/lib/pixelpress.rb

@@ -0,0 +1,8 @@
+require 'pixelpress/version'
+require 'pixelpress/base'
+require 'pixelpress/document'
+require 'pixelpress/engine' if defined? Rails
+require 'pixelpress/preview' if defined? Rails
+
+module Pixelpress
+end

data/lib/pixelpress/base.rb

@@ -0,0 +1,12 @@
+require 'action_controller'
+require_relative 'renderers/weasyprint_renderer'
+require_relative 'renderers/test_renderer'
+require_relative 'instance_invocation'
+require_relative 'rendering'
+
+module Pixelpress
+  class Base < ActionController::Base
+    extend InstanceInvocation
+    include Rendering
+  end
+end

data/lib/pixelpress/document.rb

@@ -0,0 +1,26 @@
+require_relative 'fake_file'
+
+module Pixelpress
+  class Document
+    attr_reader :html
+    attr_reader :file_name
+
+    def initialize(html, renderer, options = {})
+      @html = html
+      @renderer = renderer
+      @file_name = options[:file_name]
+    end
+
+    def pdf
+      FakeFile.new pdf_data, original_filename: file_name
+    end
+
+    private
+
+    attr_accessor :renderer
+
+    def pdf_data
+      @pdf_data ||= renderer.render(html)
+    end
+  end
+end

data/lib/pixelpress/engine.rb

@@ -0,0 +1,5 @@
+module Pixelpress
+  class Engine < ::Rails::Engine
+    isolate_namespace Pixelpress
+  end
+end

data/lib/pixelpress/fake_file.rb

@@ -0,0 +1,19 @@
+module Pixelpress
+  class FakeFile < StringIO
+    attr_accessor :original_filename, :content_type
+
+    def initialize(data, options = {})
+      @original_filename = options[:original_filename]
+      @content_type = options[:content_type]
+      super data
+    end
+
+    def original_filename
+      @original_filename || "document.pdf"
+    end
+
+    def content_type
+      @content_type || "application/pdf"
+    end
+  end
+end

data/lib/pixelpress/instance_invocation.rb

@@ -0,0 +1,15 @@
+module Pixelpress
+  module InstanceInvocation
+    def method_missing(m, *args, &block)
+      return super unless respond_to_missing?(m)
+      instance = new
+      instance.instance_variable_set :@template_name, m.to_s
+      instance.send(m, *args)
+      instance.document
+    end
+
+    def respond_to_missing?(m, include_private = false)
+      return true if new.methods.include?(m)
+    end
+  end
+end

data/lib/pixelpress/preview.rb

@@ -0,0 +1,18 @@
+module Pixelpress
+  class Preview
+    def self.all
+      Dir[Rails.root.join('spec', 'printers', 'previews', '**', '*_preview.rb')].map do |file|
+        require_dependency file
+        file.split('printers/previews/').last.sub('.rb', '').classify.constantize.new
+      end
+    end
+
+    def previews
+      methods - Object.methods - [:previews, :printer_name]
+    end
+
+    def printer_name
+      self.class.name.underscore.tr('/', '_')
+    end
+  end
+end

data/lib/pixelpress/renderers/test_renderer.rb

@@ -0,0 +1,5 @@
+class Pixelpress::TestRenderer
+  def render(html)
+     '%PDF-1.5'
+  end
+end

data/lib/pixelpress/renderers/weasyprint_renderer.rb

@@ -0,0 +1,7 @@
+require 'weasyprint'
+
+class Pixelpress::WeasyPrintRenderer
+  def render(html)
+    WeasyPrint.new(html).to_pdf
+  end
+end

data/lib/pixelpress/rendering.rb

@@ -0,0 +1,28 @@
+module Pixelpress
+  module Rendering
+    module ClassMethods
+      attr_writer :default_renderer
+      def default_renderer
+        @default_renderer ||= WeasyPrintRenderer.new
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def document
+      @document ||= Document.new render_to_string(template), renderer, file_name: try(:file_name)
+    end
+
+    protected
+
+    def renderer
+      @renderer || self.class.default_renderer
+    end
+
+    def template
+      ['printers', controller_path.sub('_printer', ''), @template_name].join('/')
+    end
+  end
+end

data/lib/pixelpress/version.rb

@@ -0,0 +1,3 @@
+module Pixelpress
+  VERSION = '0.1.0'.freeze
+end

data/pixelpress.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pixelpress/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pixelpress'
+  spec.version       = Pixelpress::VERSION
+  spec.authors       = ['Alex']
+  spec.email         = ['aleksandra@nerdgeschoss.de']
+
+  spec.summary       = 'PDF printer'
+  spec.homepage      = 'https://github.com/nerdgeschoss/pixelpress'
+  spec.license       = 'MIT'
+
+  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_dependency 'actionpack'
+  spec.add_dependency 'weasyprint'
+  spec.add_dependency 'generator_spec', '~> 0.9.3'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: pixelpress
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: weasyprint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+description: 
+email:
+- aleksandra@nerdgeschoss.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/pixelpress/printers_controller.rb
+- app/views/pixelpress/printers/index.html.erb
+- bin/console
+- bin/setup
+- bundle
+- config/routes.rb
+- lib/generators/pixelpress/printer/USAGE
+- lib/generators/pixelpress/printer/printer_generator.rb
+- lib/generators/pixelpress/printer/templates/application_printer.rb
+- lib/generators/pixelpress/printer/templates/initializer.rb
+- lib/generators/pixelpress/printer/templates/printer.pdf.erb
+- lib/generators/pixelpress/printer/templates/printer.rb
+- lib/generators/pixelpress/printer/templates/template.pdf.erb
+- lib/generators/rspec/printer_generator.rb
+- lib/generators/rspec/templates/preview.rb
+- lib/generators/rspec/templates/printer_spec.rb
+- lib/pixelpress.rb
+- lib/pixelpress/base.rb
+- lib/pixelpress/document.rb
+- lib/pixelpress/engine.rb
+- lib/pixelpress/fake_file.rb
+- lib/pixelpress/instance_invocation.rb
+- lib/pixelpress/preview.rb
+- lib/pixelpress/renderers/test_renderer.rb
+- lib/pixelpress/renderers/weasyprint_renderer.rb
+- lib/pixelpress/rendering.rb
+- lib/pixelpress/version.rb
+- pixelpress.gemspec
+homepage: https://github.com/nerdgeschoss/pixelpress
+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.6.8
+signing_key: 
+specification_version: 4
+summary: PDF printer
+test_files: []