letter_generator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be0893576b7ad361c4faf4417f45028394e0ff11
+  data.tar.gz: ee4c9f749d894a296b487c46c8717b1ef31067a1
+SHA512:
+  metadata.gz: b8e1ae11d6730c6f82b2ca734da898c6c68dc91a7e35b79798d0e82d7a8e8c17b5f50ae9cbe4184fd06c4804a38a549a28ed519f8348feba0774202f3ce1bcd2
+  data.tar.gz: df33f8f93b4eb32cf11c1c83c6d4cc2df327529c0cf0e4ab1f4f8cbe7bd8342271c855d5fffbb405acbc653471ed84b53d727de81c975aebd87a87cfe2acd201

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--format Fuubar
+--order rand
+--color

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  Exclude:
+    - 'tmp/**/*'
+
+# Configuration parameters: MaxSlashes.
+Style/RegexpLiteral:
+  MaxSlashes: 0
+
+Metrics/AbcSize:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+class ExcludeRegexFilter < SimpleCov::Filter
+  def matches?(source_file)
+    source_file.filename !~ filter_argument
+  end
+end
+
+class IncludeRegexFilter < SimpleCov::Filter
+  def matches?(source_file)
+    source_file.filename =~ filter_argument
+  end
+end
+
+SimpleCov.start do
+  add_filter "/features/"
+  add_filter "/fixtures/"
+  add_filter "/spec/"
+  add_filter "/tmp"
+  add_filter "/vendor"
+  add_filter "/cli"
+  
+  add_group "lib", ExcludeRegexFilter.new(%r{/cli/|/commands/})
+  #add_group "cli", IncludeRegexFilter.new(%r{/cli/|/commands/})
+end

data/.yardopts

@@ -0,0 +1,5 @@
+-o doc/yard
+--verbose
+-
+LICENSE.md
+README.md

data/Gemfile

@@ -0,0 +1,50 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'stackprof'
+  gem 'rspec', require: false
+  gem 'fuubar', require: false
+  gem 'simplecov', require: false
+  gem 'rubocop', '>= 0.25.0', require: false
+  gem 'coveralls', require: false
+  gem 'cucumber', require: false
+  gem 'aruba', git: 'https://github.com/cucumber/aruba.git'
+  gem 'bundler', require: false
+  gem 'erubis'
+  gem 'versionomy', require: false
+  gem 'activesupport', require: false
+  gem 'awesome_print', require: 'ap'
+
+  gem 'mutant', require: false
+  gem 'mutant-rspec', require: false
+
+  gem 'foreman', require: false
+  gem 'github-markup'
+  gem 'redcarpet', require: false
+  gem 'tmrb', require: false
+  gem 'yard', require: false
+  gem 'inch', require: false
+  gem 'license_finder', require: false
+  gem 'filegen', require: false
+  gem 'travis-lint', require: false
+  gem 'command_exec', require: false
+  gem 'rake', require: false
+  gem 'launchy', require: false
+
+  gem 'excon', require: false
+
+  gem 'therubyracer'
+  gem 'therubyrhino'
+
+  gem 'rugged'
+  gem 'addressable'
+end
+
+group :debug do
+  gem 'byebug'
+  gem 'pry'
+  gem 'pry-byebug', require: false
+  gem 'pry-doc', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Max Meyer
+
+MIT License
+
+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,31 @@
+# LetterGenerator
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'letter_generator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install letter_generator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/letter_generator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+namespace :gem do
+  require 'bundler/gem_tasks'
+end

data/bin/letter_generator

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'letter_generator'
+
+LetterGenerator::Runner.start

data/cucumber.yml

@@ -0,0 +1,2 @@
+default: --tags @wip:3 --tags ~@broken --tags ~@broken-external
+all: --tags ~@wip --tags ~@broken --tags ~@broken-external

data/features/generate_letter.feature

@@ -0,0 +1,10 @@
+Feature: Generate Letter
+
+  Background:
+    Given the default letter template
+
+
+  Scenario: Non-existing letter
+    Given a letter named "letter" does not exist
+    When I successfully run `letter_generator generate`
+    Then a letter named "letter" should exist

data/features/step_definitions.rb

@@ -0,0 +1,21 @@
+Given(/^a letter named "(.*?)" does not exist$/) do |name|
+  in_current_dir do
+    FileUtils.rm_f name
+  end
+end
+
+Then(/^a letter named "(.*?)" should exist$/) do |name|
+  step %(a file named "#{name}.tex" should exist)
+end
+
+Given(/^the default letter template$/) do
+  step %(a letter template named "letter" with:), File.read(File.expand_path('../../templates/letter.tex.tt', __FILE__))
+end
+
+Given(/^a letter template named "(.*?)" with:$/) do |name, string|
+  step %(a file named "~/.config/letter_generator/templates/#{name}.tex.tt" with:), string
+end
+
+Given(/^a config file named "(.*?)" with:$/) do |name, string|
+  step %(a file named "~/.config/letter_generator/#{name}" with:), string
+end

data/features/support/aruba.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+require 'aruba/cucumber'
+
+# Feature Helpers
+module FeatureHelper
+  # Helpers for aruba
+  module Aruba
+    def dirs
+      @dirs ||= %w(tmp cucumber)
+    end
+  end
+end
+
+World(FeatureHelper::Aruba)

data/features/support/env.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+require 'aruba/cucumber'
+
+require 'simplecov'
+SimpleCov.command_name 'cucumber'
+SimpleCov.start
+
+# Pull in all of the gems including those in the `test` group
+require 'bundler'
+Bundler.require :default, :test, :development
+
+ENV['TEST'] = 'true'

data/features/support/hash.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/core_ext/hash/options'

data/features/support/reporting.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/core_ext/kernel/reporting'

data/letter_generator.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'letter_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'letter_generator'
+  spec.version       = LetterGenerator::VERSION
+  spec.authors       = ['Max Meyer']
+  spec.email         = ['dev@fedux.org']
+  spec.summary       = 'Generate letters'
+  spec.homepage      = 'https://github.com/maxmeyer/letter_generator'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+
+  spec.add_runtime_dependency 'thor'
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'tilt'
+  spec.add_runtime_dependency 'fedux_org-stdlib'
+end

data/lib/letter_generator/application_config.rb

@@ -0,0 +1,14 @@
+module LetterGenerator
+  class ApplicationConfig < FeduxOrgStdlib::AppConfig
+    option :template, LetterTemplate.new.file
+    option :debugging_libraries, %w(pry byebug)
+
+    def _application_name
+      'letter_generator'
+    end
+
+    def _config_name
+      'application'
+    end
+  end
+end

data/lib/letter_generator/generate.rb

@@ -0,0 +1 @@
+

data/lib/letter_generator/generator.rb

@@ -0,0 +1,17 @@
+module LetterGenerator
+  class Generator
+    private
+
+    attr_reader :template
+
+    public
+
+    def initialize(template_file)
+      @template = Tilt::ErubisTemplate.new(template_file)
+    end
+
+    def run(data, file)
+      File.write(file, template.render(data))
+    end
+  end
+end

data/lib/letter_generator/letter_content.rb

@@ -0,0 +1,63 @@
+module LetterGenerator
+  class LetterContent
+    private
+
+    attr_reader :data
+
+    public
+
+    def initialize
+      file = Dir.glob(File.expand_path('*.yaml')).first
+
+      if file
+        @data = Psych.load_file(file).deep_symbolize_keys
+      else
+        @data = {}
+      end
+    rescue
+      @data = {}
+    end
+
+    def from
+      @from ||= OpenStruct.new(data[:from])
+    end
+
+    def to
+      @to ||= OpenStruct.new(data[:to])
+    end
+
+    def opening
+      data.fetch(:opening, 'Sehr geehrte Damen und Herren,')
+    end
+
+    def closing
+      data.fetch(:closing, 'Mit freundlichen Grüßen')
+    end
+
+    def attachments
+      Array(data[:attachments])
+    end
+
+    def postscriptum
+      data[:postscriptum]
+    end
+
+    def text
+      data[:text]
+    end
+
+    def signature
+      data[:signature]
+    end
+
+    def subject
+      data[:subject]
+    end
+
+    %i(subject signature postscriptum text attachments closing opening).each do |m|
+      define_method "#{m}?" do
+        !m.blank?
+      end
+    end
+  end
+end

data/lib/letter_generator/letter_template.rb

@@ -0,0 +1,4 @@
+module LetterGenerator
+  class LetterTemplate < FeduxOrgStdlib::FileTemplate
+  end
+end

data/lib/letter_generator/logger.rb

@@ -0,0 +1,5 @@
+module LetterGenerator
+  # Logger
+  class Logger < FeduxOrgStdlib::Logging::Logger
+  end
+end

data/lib/letter_generator/main.rb

@@ -0,0 +1,24 @@
+module LetterGenerator
+  @logger                      = Logger.new
+  @config                      = ApplicationConfig.new(merge_files: true, safe: true)
+  @debug_mode                  = false
+
+  class << self
+    attr_reader :config, :logger
+
+    private
+
+    attr_accessor :debug_mode
+
+    public
+
+    def debug_mode_enabled?
+      debug_mode == true
+    end
+
+    def enable_debug_mode
+      self.debug_mode = true
+      LetterGenerator.config.debugging_libraries.each { |l| require l }
+    end
+  end
+end

data/lib/letter_generator/runner.rb

@@ -0,0 +1,16 @@
+module LetterGenerator
+  class Runner < Thor
+    include Thor::Actions
+
+    option :output_file, default: 'letter.tex', desc: 'Outputfile'
+
+    desc 'generate', 'Generate template'
+    def generate
+      content = LetterContent.new
+      template = LetterTemplate.new
+
+      generator = Generator.new(template.file)
+      generator.run(content, options[:output_file])
+    end
+  end
+end

data/lib/letter_generator/version.rb

@@ -0,0 +1,3 @@
+module LetterGenerator
+  VERSION = '0.0.1'
+end

data/lib/letter_generator.rb

@@ -0,0 +1,22 @@
+require 'thor'
+require 'thor/actions'
+require 'tilt'
+require 'psych'
+require 'active_support'
+require 'active_support/core_ext'
+require 'fedux_org_stdlib/file_template'
+require 'fedux_org_stdlib/app_config'
+require 'fedux_org_stdlib/logging/logger'
+
+require 'letter_generator/letter_template'
+require 'letter_generator/logger'
+require 'letter_generator/application_config'
+require 'letter_generator/main'
+require 'letter_generator/version'
+require 'letter_generator/logger'
+require 'letter_generator/generator'
+require 'letter_generator/letter_content'
+require 'letter_generator/runner'
+
+module LetterGenerator
+end

data/spec/support/aruba.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+require 'aruba/api'
+require 'aruba/reporting'
+
+# Spec Helpers
+module SpecHelper
+  # Helpers for aruba
+  module Aruba
+    include ::Aruba::Api
+
+    def dirs
+      @dirs ||= %w(tmp rspec)
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.include SpecHelper::Aruba
+  c.before :each do
+    clean_current_dir
+    restore_env
+  end
+end

data/spec/support/reporting.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/core_ext/kernel/reporting'

data/spec/support/rspec.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+RSpec.configure do |config|
+  config.filter_run_including focus: true
+  config.run_all_when_everything_filtered = true
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_doubled_constant_names = true
+  end
+end

data/spec/support/string.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'active_support/core_ext/string/strip'

data/templates/letter.tex.tt

@@ -0,0 +1,74 @@
+\documentclass[%
+%fromphone=true,
+fromalign=left,
+foldmarks=BmTP,
+draft=true,
+]{scrlttr2}
+%%%%%%%%%%% pakete %%%%%%%%%%%%%%
+\usepackage[utf8]{inputenc}
+\usepackage[T1]{fontenc}
+\usepackage[english,german]{babel}
+\usepackage[%
+pdfborder=0 0 0,
+plainpages=false,
+pdftitle={titel},
+pdfauthor={<%= from.name %>},
+]{hyperref}
+\usepackage{graphicx}
+\usepackage{xcolor}
+\usepackage{blindtext}
+\usepackage{paralist}
+ 
+\begin{document}
+
+<% if subject? -%>
+\pagestyle{headings}
+<% end -%>
+ 
+%%%%%%%%%%% Brief %%%%%%%%%%%%%%%%
+%%%%%%%%%%% Empfänger %%%%%%%%%%%%%%%%%
+\begin{letter}{%
+<%= to.name %>\\
+<% if to.co -%>
+<%= to.co %>\\
+<% end -%>
+<%= to.street %>\\
+<%= to.city %>
+}
+ 
+%%%%%%%%%%%%% Absender %%%%%%%%%%%%%%%%%
+\setkomavar{fromname}{<%= from.name %>}
+<% unless from.phone.blank? -%>
+\setkomavar{fromphone}{<%= from.phone %> }
+<% end -%>
+\setkomavar{fromaddress}{<%= from.street %>\\<%= from.city %>}
+ 
+%%%%%%%%%%%%% Betreff %%%%%%%%%%%%%%%%
+  \setkomavar{subject}{<%= subject %>}
+ 
+%%%%%%%%%%%%% Unterschrift %%%%%%%%%%%%%%%%
+<% unless signature.blank? -%>
+\setkomavar{signature}{<%= signature %>}
+<% end %>
+ 
+ 
+%\LoadLetterOption{DIN}
+\opening{<%= opening %>}
+
+<% unless text.blank? -%>
+<%= text %>
+<% end -%>
+ 
+\closing{<%= closing %>}
+%%%%%%%%%%%%% Postscriptum %%%%%%%%%%%%%%%
+<% unless postscriptum.blank? -%>
+\ps PS: 
+<% end -%>
+ 
+%%%%%%%%%%%%% Anhänge %%%%%%%%%%%%%%%
+<% attachments.each do |a| -%>
+\encl{<%= a %>}
+<% end -%>
+ 
+\end{letter}
+\end{document}

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: letter_generator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Max Meyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: activesupport
+  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: tilt
+  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: fedux_org-stdlib
+  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: 
+email:
+- dev@fedux.org
+executables:
+- letter_generator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/letter_generator
+- cucumber.yml
+- features/generate_letter.feature
+- features/step_definitions.rb
+- features/support/aruba.rb
+- features/support/env.rb
+- features/support/hash.rb
+- features/support/reporting.rb
+- letter_generator.gemspec
+- lib/letter_generator.rb
+- lib/letter_generator/application_config.rb
+- lib/letter_generator/generate.rb
+- lib/letter_generator/generator.rb
+- lib/letter_generator/letter_content.rb
+- lib/letter_generator/letter_template.rb
+- lib/letter_generator/logger.rb
+- lib/letter_generator/main.rb
+- lib/letter_generator/runner.rb
+- lib/letter_generator/version.rb
+- spec/support/aruba.rb
+- spec/support/reporting.rb
+- spec/support/rspec.rb
+- spec/support/string.rb
+- templates/letter.tex.tt
+homepage: https://github.com/maxmeyer/letter_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
+signing_key: 
+specification_version: 4
+summary: Generate letters
+test_files:
+- features/generate_letter.feature
+- features/step_definitions.rb
+- features/support/aruba.rb
+- features/support/env.rb
+- features/support/hash.rb
+- features/support/reporting.rb
+- spec/support/aruba.rb
+- spec/support/reporting.rb
+- spec/support/rspec.rb
+- spec/support/string.rb
+has_rdoc: