ydoc 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed93e1a02c24db6c062f1476f3ef79c5cc561c74
+  data.tar.gz: 4ed7233b5d37caf3ed5f41cbc872cc3aa0a6f255
+SHA512:
+  metadata.gz: 7997b292ad538335634dbedb0b5015e461b1494256ac5944892c6ca0c9901087b442e1fea86a7277b17a90b9bb509c058315b292fbe38a4c02545eb67f587cae
+  data.tar.gz: 84b0635ab7bf9258433ed4ee72ecc7719930521ae26bfd250e9df94d9798da826b7c4f62905c511061ff3066330ef6612d5876e4e0b87948290d3cc3c051212b

data/.gitignore

@@ -0,0 +1,4 @@
+./idea
+test/input
+test/config
+*.gem

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'ruyml', :path => '/Users/s.neidig/Projects/Ruby/ruyml'
+gem 'map'
+gem 'mail'

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    ydoc (0.4.0)
+      gli (= 2.14.0)
+
+PATH
+  remote: /Users/s.neidig/Projects/Ruby/ruyml
+  specs:
+    ruyml (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.14.2)
+      childprocess (~> 0.5.6)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      ffi (~> 1.9.10)
+      rspec-expectations (>= 2.99)
+      thor (~> 0.19)
+    builder (3.2.2)
+    childprocess (0.5.9)
+      ffi (~> 1.0, >= 1.0.11)
+    contracts (0.14.0)
+    cucumber (2.4.0)
+      builder (>= 2.1.2)
+      cucumber-core (~> 1.5.0)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 4.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.5.0)
+      gherkin (~> 4.0)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.2.5)
+    ffi (1.9.14)
+    gherkin (4.0.0)
+    gli (2.14.0)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    map (6.6.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    multi_json (1.12.1)
+    multi_test (0.1.2)
+    rake (11.3.0)
+    rdoc (5.0.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    thor (0.19.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  mail
+  map
+  rake
+  rdoc
+  ruyml!
+  ydoc!
+
+BUNDLED WITH
+   1.13.6

data/README.md

@@ -0,0 +1,93 @@
+# YDoc
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ydoc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ydoc
+
+## Usage
+
+This gem provides the infrastructure to create, manage and send protocols, which are based on yaml files. Protocols 
+often follow the same scheme and require the same information. Hence we can use a templates based approach. In the 
+yaml file you declare basic information for a meeting. The yaml file can then be converted to html using pandoc as 
+middleware. So make sure pandoc is installed. Also you can send the protocol by email. 
+
+### Create
+
+```
+ydoc create 
+```
+
+Generates a yaml template. You can provide additional information to fill the yaml file.
+
+### Build
+
+```
+ydoc build %file_or_directory
+```
+
+Creates a html file based on yaml files. First argument is either a yaml file or a directory containing yaml files. 
+You can provide a config file serving additional information, which are used during pandoc conversion
+
+    {
+      "html": {
+        "toc": true,
+        "tocDepth": 1,
+        "selfContained": true,
+        "standAlone": true,
+        "numbered": true,
+        "version": "1.0.0"
+      }
+    }
+
+### Send
+
+```
+ydoc send %file
+```
+
+Sends an email to the present people of the meeting containing the html report as attachment. You have to provide a 
+config file serving smtp information to send the email with. Here is an example file
+
+    {
+      "email": {
+        "address": "noreply@domain.com",
+        "port": 587,
+        "host": "smtp.gmail.com",
+        "username": "sender@gmail.com",
+        "password": "senderpassword"
+      }
+    }
+
+### Help
+
+```
+ydoc help
+```
+
+## 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]/ydoc. 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).
+

data/README.rdoc

@@ -0,0 +1,6 @@
+= appcom-ydoc-ruby
+
+Describe your project here
+
+:include:appcom-ydoc-ruby.rdoc
+

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+require 'cucumber'
+require 'cucumber/rake/task'
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'Your application title'
+end
+
+spec = eval(File.read('appcom-ydoc-ruby.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+desc 'Run features'
+Cucumber::Rake::Task.new(:features) do |t|
+  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
+  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts =  opts
+  t.fork = false
+end
+
+desc 'Run features tagged as work-in-progress (@wip)'
+Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags ~@pending'
+  tag_opts = ' --tags @wip'
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+
+task :cucumber => :features
+task 'cucumber:wip' => 'features:wip'
+task :wip => 'features:wip'
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => [:test,:features]

data/appcom-ydoc-ruby.gemspec

@@ -0,0 +1,23 @@
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__),'lib','appcom-ydoc-ruby','version.rb'])
+spec = Gem::Specification.new do |s| 
+  s.name = 'ydoc'
+  s.version = AppcomYdocRuby::VERSION
+  s.author = 'Stefan Neidig'
+  s.email = 's.neidig@appcom-interactive.de'
+  s.homepage = 'http://appcom-interactive.de'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'A description of your project'
+  s.files = `git ls-files`.split("
+")
+  s.require_paths << 'lib'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README.rdoc','appcom-ydoc-ruby.rdoc']
+  s.rdoc_options << '--title' << 'appcom-ydoc-ruby' << '--main' << 'README.rdoc' << '-ri'
+  s.bindir = 'bin'
+  s.executables << 'ydoc'
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rdoc')
+  s.add_development_dependency('aruba')
+  s.add_runtime_dependency('gli','2.14.0')
+end

data/appcom-ydoc-ruby.rdoc

@@ -0,0 +1,5 @@
+= appcom-ydoc-ruby
+
+Generate this with
+    appcom-ydoc-ruby rdoc
+After you have described your command line interface

data/bin/ydoc

@@ -0,0 +1,124 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'map'
+require 'yaml'
+require 'appcom-ydoc-ruby'
+
+include GLI::App
+
+program_desc 'This is a CLI for creating and distributing meeting protocols'
+
+version AppcomYdocRuby::VERSION
+
+subcommand_option_handling :normal
+arguments :strict
+
+desc 'Create an empty yaml template'
+arg_name ''
+command :create do |c|
+  c.desc 'The title of the document to create'
+  c.flag [:t, :title]
+
+  c.desc 'The moderator of the meeting'
+  c.flag [:m, :moderator]
+
+  c.desc 'The recorder of the meeting'
+  c.flag [:r, :recorder]
+
+  c.desc 'The objective of the meeting'
+  c.flag [:o, :objective]
+
+  c.desc 'The summary of the meeting'
+  c.flag [:s, :summary]
+
+  c.desc 'The output filename for the generated file'
+  c.default_value '.'
+  c.flag [:d, :directory]
+
+  c.action do |global_options, options, args|
+    builder = YDoc::YamlBuilder.new
+    builder.create options[:d], options
+
+    puts "Created file under #{options[:d]}"
+  end
+end
+
+desc 'Build html from yaml template'
+arg_name 'Filename of the yaml template or a directory containing yaml files'
+command :build do |c|
+  c.desc 'The output filename for the generated file'
+  c.default_value '.'
+  c.flag [:d, :directory]
+
+  c.desc 'A flag indicating that the table of contents is also added'
+  c.switch [:t, :toc]
+
+  c.desc 'A number indicating the maximum depth for the table of contents'
+  c.flag [:T, :tocDepth]
+
+  c.desc 'A flag indicating that the sections should be nubered automatically'
+  c.switch [:n, :numbered]
+
+  c.desc 'A flag indicating that the resulting page should be stand alone'
+  c.switch [:s, :standAlone]
+
+  c.desc 'A flag indicating that the resulting page should be self contained'
+  c.switch [:S, :selfContained]
+
+  c.desc 'A file path where a valid configuration file is located'
+  c.flag [:c, :config]
+
+  c.action do |global_options, options, args|
+    temp_directory = "temp_#{Date.new.to_time.to_i}"
+    FileUtils.mkdir_p(temp_directory)
+
+    YDoc::build_html(args[0], temp_directory, options[:d], options)
+
+    FileUtils.rm_rf(temp_directory)
+  end
+end
+
+desc 'Sends a protocol by email. The yaml file is parsed and converted to html and sent to the recipients described in the yaml.'
+arg_name 'Filename of the yaml template or a directory containing the yaml files, which should be sent'
+command :send do |c|
+  c.desc 'A file path where a valid configuration file is located'
+  c.flag [:c, :config]
+
+  c.desc 'The subject of the email'
+  c.flag [:s, :subject]
+
+  c.desc 'The body of the email'
+  c.flag [:b, :body]
+
+  c.desc 'The body of the email as file. If present the --body options is ignored'
+  c.flag [:f, :filename]
+
+  c.action do |global_options, options, args|
+    if !args[0] || !args[0].end_with?('yaml')
+      puts 'The first parameter must be a path to a yaml file'
+      abort
+    end
+
+    temp_directory = "temp_#{Date.new.to_time.to_i}"
+    FileUtils.mkdir_p temp_directory
+
+    YDoc::build_html(args[0], temp_directory, temp_directory, options)
+
+    file = Dir["#{temp_directory}/*"].select { |f| f.end_with?('html') }[0]
+    body = options[:filename] ? File.read(options[:filename]) : options[:body]
+    to = Map[YAML.load_file(args[0])][:present].map { |present| present[:email] }.join(',')
+
+    email_builder = YDoc::EmailBuilder.new
+    email_builder.mail_to(to, options[:subject], body, file, options)
+
+    FileUtils.rm_rf temp_directory
+  end
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+exit run(ARGV)

data/features/appcom-ydoc-ruby.feature

@@ -0,0 +1,8 @@
+Feature: My bootstrapped app kinda works
+  In order to get going on coding my awesome app
+  I want to have aruba and cucumber setup
+  So I don't have to do it myself
+
+  Scenario: App just runs
+    When I get help for "appcom-ydoc-ruby"
+    Then the exit status should be 0

data/features/step_definitions/appcom-ydoc-ruby_steps.rb

@@ -0,0 +1,6 @@
+When /^I get help for "([^"]*)"$/ do |app_name|
+  @app_name = app_name
+  step %(I run `#{app_name} help`)
+end
+
+# Add more step definitions here

data/features/support/env.rb

@@ -0,0 +1,15 @@
+require 'aruba/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end

data/lib/appcom-ydoc-ruby.rb

@@ -0,0 +1,22 @@
+require_relative 'appcom-ydoc-ruby/version.rb'
+require_relative 'appcom-ydoc-ruby/markdown/markdown_builder'
+require_relative 'appcom-ydoc-ruby/html/html_builder'
+require_relative 'appcom-ydoc-ruby/yaml/yaml_builder'
+require_relative 'appcom-ydoc-ruby/email/email_builder'
+
+# Add requires for other files you add to your project here, so
+# you just need to require this one file in your bin file
+
+module YDoc
+
+  def build_html input_directory, temp_directory, output_directory, options
+    markdown_builder = MarkdownBuilder.new
+    markdown_builder.to_markdown(input_directory, temp_directory)
+
+    html_builder = HtmlBuilder.new
+    html_builder.to_html(temp_directory, output_directory, options)
+  end
+
+  module_function :build_html
+
+end