signature_generator 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f7bf9f84d0258e6fc0eaac70bf19a65a1c3093f
+  data.tar.gz: 902bc3dab4a1809e7c090c9033058c40b63e52c7
+SHA512:
+  metadata.gz: 2290c0db425a9b29f1914d8dfc5a3ad86f9fc4c5b573372e173d06a3b8df55cfe91c1da50ff13069b9ce32e792d33feea40cfe0427d3d72944c35afbd5faa59a
+  data.tar.gz: 20f1e4f3bbf1067ae0438dc2ef8dc4424b58fefccd148920b234da2b2314ef1b6f5c80d08e6697a59a0d8eaf5daec2e0e86fcb5ba819da8c89e1dbf559e2d7fb

data/.gitignore

@@ -0,0 +1,182 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+### Ruby template
+*.gem
+*.rbc
+/.config
+/InstalledFiles
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/rdoc/
+
+## Environment normalization:
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+### SublimeText template
+# cache files for sublime text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+
+# workspace files are user-specific
+*.sublime-workspace
+
+# project files should be checked into the repository, unless a significant
+# proportion of contributors will probably not be using SublimeText
+# *.sublime-project
+
+# sftp configuration file
+sftp-config.json
+
+# Package control specific files
+Package Control.last-run
+Package Control.ca-list
+Package Control.ca-bundle
+Package Control.system-ca-bundle
+Package Control.cache/
+Package Control.ca-certs/
+bh_unicode_properties.cache
+
+# Sublime-github package stores a github token in this file
+# https://packagecontrol.io/packages/sublime-github
+GitHub.sublime-settings
+### KDevelop4 template
+*.kdev4
+.kdev4/
+### Linux template
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+### Eclipse template
+
+.metadata
+bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.settings/
+.loadpath
+.recommenders
+
+# Eclipse Core
+.project
+
+# External tool builders
+.externalToolBuilders/
+
+# Locally stored "Eclipse launch configurations"
+*.launch
+
+# PyDev specific (Python IDE for Eclipse)
+*.pydevproject
+
+# CDT-specific (C/C++ Development Tooling)
+.cproject
+
+# JDT-specific (Eclipse Java Development Tools)
+.classpath
+
+# Java annotation processor (APT)
+.factorypath
+
+# PDT-specific (PHP Development Tools)
+.buildpath
+
+# sbteclipse plugin
+.target
+
+# Tern plugin
+.tern-project
+
+# TeXlipse plugin
+.texlipse
+
+# STS (Spring Tool Suite)
+.springBeans
+
+# Code Recommenders
+.recommenders/
+### VisualStudioCode template
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff:
+.idea/
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2
+script:
+  - bundle exec rspec -f d 2> /dev/null

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at lbnetid+gh@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Laurent B.
+
+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,78 @@
+# Signature Generator
+
+[![Build Status](https://travis-ci.org/lbriais/signature_generator.svg)](https://travis-ci.org/lbriais/signature_generator)
+[![Gem Version](https://badge.fury.io/rb/signature_generator.svg)](http://badge.fury.io/rb/signature_generator)
+
+
+This gem provides the `sg` executable to generate signature files from templates.
+Variables used in the template, can be provided at run-time either by:
+
+* Providing values on command line
+* Providing values in config file
+* Interactively
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'signature_generator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install signature_generator
+
+## Usage
+
+By default, the template is taken from STDIN and the result is produced on STDOUT. Of course both template and
+result files can be specified on command line (see `sg --help` to see all options).
+
+### Template
+
+The template is actually an [ERB](http://www.stuartellis.name/articles/erb/) template.
+
+### Resulting file
+
+By default the result is _minified_ using the [kangax minifier](https://github.com/kangax/html-minifier/). You can disable
+this behaviour by specifying `--no-minify` on the command line.
+
+### Substituting variables
+
+You can specify variables on the command line using the following syntax: `--var varname1=value1 --var varname2=value2 ...`
+
+Here is a real-life usage example:
+
+    $ sg -f ./my_template.html.erb -o my_signature_file.html --force --var varname1=value1 --var varname2=value2 
+
+As this gem is using [easy_app_helper], it means that anything you can provide on the command line can 
+be actually provided by a config file. Read [easy_app_helper] documentation for further info.
+
+__Any variable value not provided by the command line or a config file will actually be requested interactively at run time.__
+
+## 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/lbriais/signature_generator. 
+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](http://opensource.org/licenses/MIT).
+
+[easy_app_helper]: https://github.com/lbriais/easy_app_helper "easy_app_helper Gem'

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+task :default => :spec
+
+require 'easy_app_helper/tasks'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'signature_generator'
+
+# 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/exe/sg

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+# This file has been generated by easy_app_helper Gem on the Sun Dec 11 12:11:18 2016
+# See 'https://rubygems.org/gems/easy_app_helper'
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'easy_app_helper'
+require 'easy_app_helper/scripts'
+require 'signature_generator'
+require 'html_minifier'
+
+module SignatureGenerator
+  class SgMasterScript < EasyAppHelper::Scripts::Master
+
+    # If you want to manage sub-commands a-la-git, include following
+    # include EasyAppHelper::Scripts::SubCommandManager
+
+    NAME = 'Sg'
+    DESCRIPTION = 'Description of sg'
+
+    attr_reader :template_io, :output_io, :context
+
+    def initialize
+      super(NAME, SignatureGenerator::VERSION, DESCRIPTION, 'sg')
+    end
+
+    def add_script_options
+      ## Create here your extra command-line options
+      ## Here under are examples using potentially gem config layer to display default option value...
+      ## Check Slop documentation for further info.
+      config.add_command_line_section do |slop|
+        slop.on :f, :'template-file', 'Specify the signature template file. Default is STDIN.', argument: true, as: String
+        slop.on :o, :'output-file', 'Specify the output file for the signature. Default is STDOUT.', argument: true, as: String
+        slop.on :force, 'Force overwriting output file.', argument: false
+        slop.on :var=, 'Define variables in the form name=value', argument: true, as: Array
+        slop.on :n, :'no-minify', 'Will not minify the resulting html signature. By default will do', argument: false
+      end
+    end
+
+    def do_process
+      # Your code here.
+      content = template_io.read
+      logger.debug content
+      processor = SignatureGenerator::Processor.new context
+      signature = processor.transform content
+      logger.debug signature
+      unless config[:'no-minify']
+        minifier = HtmlMinifier::Minifier.new collapseWhitespace: true, collapseInlineTagWhitespace: true
+        signature = minifier.minify signature
+        logger.debug 'Minifying resulting signature'
+        logger.debug signature
+      end
+      output_io.puts signature
+    ensure
+      template_io.close
+      output_io.close
+    end
+
+    def check_config
+      # Check the config and raise an exception if incorrect.
+      config[:var] ||=[]
+      @context = {}
+      config[:var].each do |definition|
+        valid = false
+        definition.match(/^\s*(?<var_name>[a-z][a-z0-9_]*)\s*=\s*(?<var_value>.+)\s*$/) do |md|
+          logger.warning "Overwriting existing variable '#{md['var_name']}' !" if context[md['var_name']]
+          context[md['var_name'].to_sym] = md['var_value']
+          valid = true
+        end
+        raise SignatureGenerator::Error, 'Invalid property specified !' unless valid
+      end
+
+      @template_io = case config[:'template-file']
+                       when NilClass
+                         logger.debug 'Template from STDIN'
+                         STDIN
+                       when String
+                         file = File.expand_path(config[:'template-file'])
+                         raise SignatureGenerator::Error, 'Invalid template file specified !' unless File.readable? file
+                         io = File.open file, 'r'
+                         logger.debug "Template from file '#{file}'"
+                         io
+                     end
+      @output_io = case config[:'output-file']
+                     when NilClass
+                       logger.debug 'Signature to STDOUT'
+                       STDOUT
+                     when String
+                       file = File.expand_path(config[:'output-file'])
+                       if File.exists? file
+                         raise SignatureGenerator::Error, 'Output file already exists ! Use --force' unless config[:force]
+                       end
+                       io = File.open file, 'w'
+                       logger.debug "Signature generated into file '#{file}'"
+                       io
+                   end
+    end
+
+  end
+end
+
+SignatureGenerator::SgMasterScript.new.run

data/lib/signature_generator/context.rb

@@ -0,0 +1,26 @@
+
+module SignatureGenerator
+
+  class Context
+
+    def initialize(hash={})
+      @internal_hash = hash
+    end
+
+    def []=(key,val)
+      internal_hash[key] = val
+    end
+
+    def method_missing(*args)
+      method_name = args.shift
+      return internal_hash[method_name] if internal_hash[method_name]
+      super(method_name, *args)
+    end
+
+    private
+
+    attr_reader :internal_hash
+
+  end
+
+end

data/lib/signature_generator/error.rb

@@ -0,0 +1,5 @@
+module SignatureGenerator
+
+  class Error < StandardError ; end
+
+end

data/lib/signature_generator/processor.rb

@@ -0,0 +1,57 @@
+require 'erb'
+
+module SignatureGenerator
+
+  class Processor
+
+    include EasyAppHelper
+    include EasyAppHelper::Input
+    MAX_RETRY = 3
+
+    attr_reader :results, :context
+
+    def initialize(context={})
+      self.context = context
+    end
+
+    def transform(template, context = self.context)
+      counters = {}
+      begin
+        @results = ERB.new(template, nil, '-').result(context_as_binding context)
+      rescue NameError => e
+        missing_var = e.name
+        counters[missing_var] ||= 0
+        counters[missing_var] += 1
+        debug_msg = "Variable not provided: #{missing_var} (attempt ##{counters[missing_var]})"
+        logger.debug debug_msg
+        if counters[missing_var] > MAX_RETRY
+          logger.error 'Maximum retry number exceeded. Aborting !'
+          raise e
+        end
+        user_input = get_user_input "Please enter value for '#{missing_var}' > "
+        context[missing_var] = user_input unless user_input.nil? or user_input.empty?
+        retry
+      end
+    end
+
+    def context=(context)
+      raise SignatureGenerator::Error, 'Context cannot be nil' if context.nil?
+      @context = case context
+                   when Hash
+                     SignatureGenerator::Context.new context
+                   when SignatureGenerator::Context
+                     context
+                 end
+    end
+
+    private
+
+    def context_as_binding(context)
+      context.instance_eval do
+        binding
+      end
+    end
+
+  end
+
+end

data/lib/signature_generator/version.rb

@@ -0,0 +1,3 @@
+module SignatureGenerator
+  VERSION = '0.1.1'
+end

data/lib/signature_generator.rb

@@ -0,0 +1,10 @@
+require 'easy_app_helper'
+
+require 'signature_generator/version'
+require 'signature_generator/error'
+require 'signature_generator/context'
+require 'signature_generator/processor'
+
+module SignatureGenerator
+  # Your code goes here...
+end

data/signature_generator.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'signature_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'signature_generator'
+  spec.version       = SignatureGenerator::VERSION
+  spec.authors       = ['Laurent B.']
+  spec.email         = ['lbnetid+gh@gmail.com']
+
+  spec.summary       = %q{Generates an HTML signature to be used in mail UA from template.}
+  spec.description   = %q{Generates an HTML signature to be used in mail UA from template with multiple mechanisms for substitution.}
+  spec.homepage      = 'https://github.com/lbriais/signature_generator'
+  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 'pry'
+  spec.add_development_dependency 'rspec'
+
+  spec.add_dependency 'easy_app_helper', '~> 4.2'
+  spec.add_dependency 'html_minifier'
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: signature_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Laurent B.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: pry
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: easy_app_helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: html_minifier
+  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'
+description: Generates an HTML signature to be used in mail UA from template with
+  multiple mechanisms for substitution.
+email:
+- lbnetid+gh@gmail.com
+executables:
+- sg
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/sg
+- lib/signature_generator.rb
+- lib/signature_generator/context.rb
+- lib/signature_generator/error.rb
+- lib/signature_generator/processor.rb
+- lib/signature_generator/version.rb
+- signature_generator.gemspec
+homepage: https://github.com/lbriais/signature_generator
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Generates an HTML signature to be used in mail UA from template.
+test_files: []