RubyGems - printr - Versions diffs - 0.0.1 - Mend

printr 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (22) hide show

data/.gitignore +4 -0
data/Gemfile +31 -0
data/README +45 -0
data/Rakefile +7 -0
data/app/helpers/application_helper.rb +2 -0
data/app/views/layouts/application.html.erb +14 -0
data/app/views/printr/item.prnt.erb +0 -0
data/config/locales/en.yml +5 -0
data/config.ru +4 -0
data/db/seeds.rb +7 -0
data/lib/generators/printr/install_generator.rb +13 -0
data/lib/generators/printr/views_generator.rb +13 -0
data/lib/generators/templates/printr.rb +3 -0
data/lib/generators/templates/printrs.yml +3 -0
data/lib/printr/engine.rb +7 -0
data/lib/printr/version.rb +3 -0
data/lib/printr.rb +157 -0
data/lib/tasks/.gitkeep +0 -0
data/printr.gemspec +21 -0
data/test/performance/browsing_test.rb +9 -0
data/test/test_helper.rb +13 -0
metadata +78 -0

data/.gitignore ADDED Viewed

@@ -0,0 +1,4 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/

data/Gemfile ADDED Viewed

@@ -0,0 +1,31 @@
+source 'http://rubygems.org'
+gem 'rails', '3.0.6'
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+gem 'serialport'
+# Use unicorn as the web server
+# gem 'unicorn'
+# Deploy with Capistrano
+# gem 'capistrano'
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19', :require => 'ruby-debug'
+# Bundle the extra gems:
+# gem 'bj'
+# gem 'nokogiri'
+# gem 'sqlite3-ruby', :require => 'sqlite3'
+# gem 'aws-s3', :require => 'aws/s3'
+# Bundle gems for the local environment. Make sure to
+# put test-only gems in this group so their generators
+# and rake tasks are available in development mode:
+# group :development, :test do
+#   gem 'webrat'
+# end

data/README ADDED Viewed

@@ -0,0 +1,45 @@
+== Welcome to Printr
+Printr is an interface to serial/usb/plain_file printers on *nix systems. You can use it with your udev
+rules etc. It is built as a rails engine, and should be used as a gem.
+You can pull the latest edition from this repo, or:
+#Gemfile
+gem 'printr'
+Then run bundle install
+The default source for printer configurations is :yaml, and expects a printrs.yml file to be present in
+RAILS_ROOT/config/, you can also feed it off of an ActiveRecord, in initializers/printr.rb
+config.printr_source = {:active_record => {
+  :class_name => YourActiveRecordClass,
+  :name => :attribute_name,
+  :path => :attribute_name }
+}
+Where:
+  :name must be an attribute of the active record object, and the value it resolves to must be
+   a snake_case_name
+  :path must be the full path to the printer, like /dev/som0 or /home/user/printer.txt
+==Basic Usage:
+@printer = Printr.new
+@printer.the_name_of_some_printer "text"
+==Advanced Usage
+Create a printr folder in your views directory for your rails app. name the view #{some_name}.prnt.erb
+So for instance, say you want an item view:
+/views/printr/item.prnt.erb
+Then somewhere in your app, call:
+@printer = Printr.new
+@printer.the_name_of_some_printer "item",binding

data/Rakefile ADDED Viewed

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+Printr::Application.load_tasks

data/app/helpers/application_helper.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ module ApplicationHelper
2	+ end

data/app/views/layouts/application.html.erb ADDED Viewed

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Printr</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

data/app/views/printr/item.prnt.erb ADDED Viewed

File without changes

data/config/locales/en.yml ADDED Viewed

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+en:
+  hello: "Hello world"

data/config.ru ADDED Viewed

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+require ::File.expand_path('../config/environment',  __FILE__)
+run Printr::Application

data/db/seeds.rb ADDED Viewed

@@ -0,0 +1,7 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
+#
+# Examples:
+#
+#   cities = City.create([{ :name => 'Chicago' }, { :name => 'Copenhagen' }])
+#   Mayor.create(:name => 'Daley', :city => cities.first)

data/lib/generators/printr/install_generator.rb ADDED Viewed

@@ -0,0 +1,13 @@
+module Printr
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates",__FILE__)
+      desc "Creates the printr initializer"
+      def copy_initializer
+        template "printr.rb", "config/initializers/printr.rb"
+        copy_file "printrs.yml","config/printrs.yml"
+      end
+    end
+  end
+end

data/lib/generators/printr/views_generator.rb ADDED Viewed

@@ -0,0 +1,13 @@
+module Printr
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../app/views",__FILE__)
+      desc "Copies default printer templates to your application"
+      argument :scope, :required => false, :default => nil,
+               :desc => "the scope to copy views to."
+      def copy_views
+        directory "printr", "app/views/#{scope || :printr}"
+      end
+    end
+  end
+end

data/lib/generators/templates/printr.rb ADDED Viewed

@@ -0,0 +1,3 @@
+Printr.setup do |config|
+end

data/lib/generators/templates/printrs.yml ADDED Viewed

@@ -0,0 +1,3 @@
+kitchen: "/dev/null"
+bar: "/dev/null"
+guest_room: "/dev/null"

data/lib/printr/engine.rb ADDED Viewed

@@ -0,0 +1,7 @@
+module Printr
+  require 'printr'
+  require 'rails'
+  class Engine < Rails::Engine
+  end
+end

data/lib/printr/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Printr
+  VERSION = "0.0.1"
+end

data/lib/printr.rb ADDED Viewed

@@ -0,0 +1,157 @@
+# coding: utf-8
+require 'yaml'
+require 'erb'
+require 'serialport'
+module Printr
+  require 'printr/engine' if defined?(Rails)
+  mattr_accessor :printr_source #:yaml or :active_record
+  @@printr_source = :yaml
+  # :active_record => {:class_name => ClassName, :name => :model_field_name, :path => :model_path_name
+                       # E.G. printr_model = {:class_name => Printer, :name => :short_name, :path => :location }
+                       # to create the list of printers it will call:
+                       # Printer.all.each { |p| @printrs[p.send(Printr.printr_model[:name].snake_case.to_sym)] = p.send(Printr.printr_model[:path]) }
+                       # so if you have a printer named bar_printer, then you can print to it with @printr.bar_printer 'textl'
+  mattr_accessor :sanitize_tokens #pair list of needle regex, replace must be by 2s, i.e. [/[abc]/,"x",/[123]/,'0']
+  @@sanitize_tokens = []
+  mattr_accessor :codes
+  @@codes = {
+      :hr => "=====================\n",
+      :header => "\e@\e!\x38",
+      :footer => "\n\n\n\n\x1DV\x00\x16\x20105"
+    }
+  mattr_accessor :printrs
+  @@printrs = {}
+  mattr_accessor :conf
+  @@conf = {}
+  def self.new
+     return Printr::Machine.new
+  end
+  def self.setup
+    yield self
+  end
+  def self.get_printers
+    if @@printr_source == :yaml then
+      @@conf = YAML::load(File.open("#{RAILS_ROOT}/config/printrs.yml"))
+    elsif @@printr_source.class == Hash then
+      if @@printr_source[:active_record] then
+          @@printr_source[:active_record][:class_name].all.each do |p|
+            key = p.send(@@printr_source[:active_record][:name]).to_sym
+            @@conf[key] = p.send(@@printr_source[:active_record][:path])
+          end
+      end
+    end
+    return self.open_printers
+  end
+  def self.open_printers
+    @@conf.each do |key,value|
+      key = key.to_sym
+      puts "[PRINTING]  Trying to open #{key}..."
+       begin
+         @@printrs[key] =  SerialPort.new(value,9600)
+         puts "[PRINTING] Success for SerialPort: #{ @printrs[key].inspect }"
+       rescue Exception => e
+         puts "[PRINTING]    Failed to open as SerialPort: #{ e.inspect }"
+         @@printrs[key] = nil
+       end
+       next if @@printrs[key]
+       # Try to open it as USB
+       begin
+         @@printrs[key] = File.open(value,'w:ISO8859-15')
+       rescue Errno::EBUSY
+         @@conf.each do |k,v|
+           if @@printrs[k] and @@printrs[k].class == File then
+             @@printrs[key] = @@printrs[k]
+             puts "[PRINTING]      Reused."
+           end
+         end
+       rescue Exception => e
+         @@printrs[key] = File.open("#{RAILS_ROOT}/tmp/dummy-#{key}.txt","a")
+         puts "[PRINTING]    Failed to open as either SerialPort or USB File. Created Dummy #{ @printrs[key].inspect } instead."
+       end
+     end
+    @@printrs
+  end
+  def self.close
+    puts "[PRINTING]============"
+    puts "[PRINTING]CLOSING Printers..."
+    @@printrs.map do |p|
+      begin
+        p.close
+      rescue
+      end
+      p = nil
+    end
+  end
+  # Instance Methods
+  class Machine
+    def initialize()
+      Printr.get_printers
+      # You can access these within the views by calling @printr.codes, or whatever
+      # you named the instance variable, as it will be snagged by the Binding
+      @codes = Printr.codes
+      # You can override the above codes in the printers.yml, to add
+      # say an ASCII header or some nonsense, or if they are using a
+      # standard printer etc etc.
+      if Printr.conf[:codes] then
+        Printr.conf[:codes].each do |key,value|
+          Printr.conf[key.to_sym] = value
+        end
+      end
+      Printr.open_printers
+    end
+    def test(key)
+    end
+    def logger
+      ActiveRecord::Base.logger
+    end
+    def print_to(key,text)
+      key = key.to_sym
+      begin
+        text = sanitize(text)
+        t = Printr.printrs[key].class
+        if Printr.printrs[key].class == File then
+            Printr.printrs[key].write text
+            Printr.printrs[key].flush
+        elsif Printr.printrs[key].class == SerialPort
+            Printr.printrs[key].write text
+        else
+            puts "Could not find #{key} #{Printr.printrs[key].class}"
+        end
+      rescue Exception => e
+        puts "#{e.inspect}"
+        Printr.close
+      end
+    end
+    def method_missing(sym, *args, &block)
+      if Printr.printrs[sym] then
+        if args[1].class == Binding then
+          print_to(sym,template(args[0],args[1])) #i.e. you call @printr.kitchen('item',binding)
+        else
+          print_to(sym,args[0])
+        end
+      end
+    end
+    def sanitize(text)
+      i = 0
+      begin
+        text.gsub!(Printr.sanitize_tokens[i],Printr.sanitize_tokens[i+1])
+        i += 2
+      end while i < Printr.sanitize_tokens.length
+      text
+    end
+    def template(name,bndng)
+      begin
+        erb = ERB.new(File.new("#{RAILS_ROOT}/app/views/printr/#{name}.prnt.erb",'r').read)
+      rescue Exception => e
+        puts e.inspect
+      end
+      text = erb.result(bndng)
+      return text
+    end
+  end
+end

data/lib/tasks/.gitkeep ADDED Viewed

File without changes

data/printr.gemspec ADDED Viewed

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "printr/version"
+Gem::Specification.new do |s|
+  s.name        = "printr"
+  s.version     = Printr::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Michael Franzl","Jason Martin"]
+  s.email       = ["jason@jason-knight-martin.com"]
+  s.homepage    = ""
+  s.summary     = %q{An engine for interfacing with printers.}
+  s.description = %q{This engine allows you to define printers and templates.}
+  s.rubyforge_project = "printr"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/test/performance/browsing_test.rb ADDED Viewed

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'rails/performance_test_help'
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionDispatch::PerformanceTest
+  def test_homepage
+    get '/'
+  end
+end

data/test/test_helper.rb ADDED Viewed

@@ -0,0 +1,13 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/test_help'
+class ActiveSupport::TestCase
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+  # Add more helper methods to be used by all tests here...
+end

metadata ADDED Viewed

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: printr
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Franzl
+- Jason Martin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-05-18 00:00:00 +02:00
+default_executable:
+dependencies: []
+description: This engine allows you to define printers and templates.
+email:
+- jason@jason-knight-martin.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- app/helpers/application_helper.rb
+- app/views/layouts/application.html.erb
+- app/views/printr/item.prnt.erb
+- config.ru
+- config/locales/en.yml
+- db/seeds.rb
+- lib/generators/printr/install_generator.rb
+- lib/generators/printr/views_generator.rb
+- lib/generators/templates/printr.rb
+- lib/generators/templates/printrs.yml
+- lib/printr.rb
+- lib/printr/engine.rb
+- lib/printr/version.rb
+- lib/tasks/.gitkeep
+- printr.gemspec
+- test/performance/browsing_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+requirements: []
+rubyforge_project: printr
+rubygems_version: 1.6.2
+signing_key:
+specification_version: 3
+summary: An engine for interfacing with printers.
+test_files: []