dogen 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11df703ef3711beab273d70f377f45a5f298b453
+  data.tar.gz: 5dff849c76ada21102e96c76474f4190a7138dcc
+SHA512:
+  metadata.gz: 011770a3ed52b24b3e9dd4377918de111ab8c4f5241523e6b83622f0c01b6ceb41ca60f9f9e8d3b76f4699798831b253c2c8d860402fe8c1c77e6c5f6f32e087
+  data.tar.gz: c04f881f519b04fe0eb6d3c78e073c8b122ac3fda2c1c13ff3b89aeb7b81d258ad60a81f30ce730d590584d82fcc5f76af3ed11511733ea463c731d46d0e978a

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--require spec_helper
+--format progress
+--no-profile

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+script: bundle exec rake
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^lib/(.+).rb$})      { |m| "spec/unit/lib/#{m[1]}_spec.rb" }
+  watch(%r{^spec/(.+).rb$})     { |m| "spec/#{m[1]}.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch('Gemfile')
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pawel Niemczyk
+
+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,68 @@
+# Dogen
+
+Documents generator for bash
+
+## Installation
+
+    $ gem install dogen
+
+## Usage
+
+    $ dogen --help
+
+### Setup repository directory
+
+    $ mkdir /home/user/Dropbox/dogen
+    $ dogen c --repository path::/home/user/Dropbox/dogen
+
+### Generate documet
+
+create document like (vcard.erb) in yours repository directory: 
+
+```
+BEGIN:VCARD
+VERSION:2.1
+N:<%= data['first_name'] %>;<%= data['last_name'] %>
+FN:<%= data['first_name'] %> <%= data['last_name'] %>
+ORG:<%= data['org'] %>
+TITLE:<%= data['title'] %>
+PHOTO;GIF:<%= data['photo'] %>
+TEL;WORK;VOICE:<%= data['home_tel'] %>
+TEL;HOME;VOICE:<%= data['work_tel'] %>
+ADR;WORK:;;<%= data['streat'] %>;<%= data['province'] %>;<%= data['state'] %>;<%= data['postcode'] %>;<%= data['country']
+LABEL;WORK;ENCODING=QUOTED-PRINTABLE:<%= data['streat'] %>=0D=0A<%= data['province'] %>, <%= data['state'] %> <%= data['postcode'] %>=0D=0A<%= data['country']
+ADR;HOME:;;42 Plantation St.;<%= data['province'] %>;<%= data['state'] %>;<%= data['postcode'] %>;<%= data['country']
+LABEL;HOME;ENCODING=QUOTED-PRINTABLE:
+EMAIL;PREF;INTERNET:<%= data['email'] %>
+REV:20080424T195243Z
+END:VCARD
+
+```
+
+and use command
+
+    $ dogen g vcard first_name:Pawel last_name:Niemczyk org:MyCompany title:Mr
+
+or prepare json with the data and use command:
+
+    $ dogen g vcard -j /home/user/tmp/my_vcard.json
+
+
+you can use patials inside any erb templates like:
+
+```
+
+Your vcard source for <%= data['first_name'] %> <%= data['last_name'] %> :
+<%= render('vcard') %>
+
+```
+
+### You can use it to any type of file
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/dogen/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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/dogen

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+require 'commander/import'
+require 'awesome_print'
+require 'dogen'
+
+base = Dogen::Base.new
+
+program :version,     Dogen::VERSION
+program :description, Dogen::DESCRIPTION
+
+command :c do |c|
+  c.syntax = 'dogen c [options]'
+  c.summary = 'configuration'
+  c.description = 'setup repository'
+  c.example 'set repository', '--repository path::/home/user/Dropbox/Templates'
+  c.option '--repository', 'setup repository source'
+  c.action do |args, options|
+    base.set_repository(args) if options.repository
+  end
+end
+
+command :g do |c|
+  c.syntax = 'dogen g [options]'
+  c.summary = 'documents generator'
+  c.description = 'All options needed to generate document'
+  c.example 'generate file', 'base/gem/README.md title:"Test title"'
+  c.example 'generate files', 'base/gem'
+  c.option '-j', 'load variables from json file'
+  c.action do |args, options|
+    path = args.shift
+    if options.j
+      opts = base.read_opts_from_json(args.first.to_s)
+      base.generate(path, opts)
+    else
+      opts = base.parse_opts(args)
+      base.generate(path, opts)
+    end
+  end
+end

data/bin/test.txt

@@ -0,0 +1 @@
+My name is pawel

data/dogen.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dogen/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dogen'
+  spec.version       = Dogen::VERSION
+  spec.authors       = ['Pawel Niemczyk']
+  spec.email         = ['pniemczyk@o2.pl']
+  spec.summary       = %q{Documents generator for bash}
+  spec.description   = %q{Documents generator for bash}
+  spec.homepage      = 'https://github.com/pniemczyk/dogen'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency 'awesome_print', '~> 1.2'
+  spec.add_dependency 'hashie', '~> 2.1'
+  spec.add_dependency 'commander', '~> 4.2'
+  spec.add_dependency 'rendering_engine', '~> 0.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'guard-rspec', '~> 0'
+  spec.add_development_dependency 'coveralls', '~> 0'
+end

data/lib/dogen.rb

@@ -0,0 +1,7 @@
+require 'dogen/version'
+require 'dogen/description'
+require 'dogen/configuration'
+require 'dogen/base'
+
+module Dogen
+end

data/lib/dogen/base.rb

@@ -0,0 +1,55 @@
+require 'rendering_engine'
+require 'awesome_print'
+
+module Dogen
+  class Base
+    def set_repository(args)
+      source, place = args.first.to_s.split('::')
+
+      if source.downcase == 'path'
+        raise "Missing path: #{place}" unless File.directory?(place)
+        configuration.set(repository: { source: 'path', place: place })
+      else
+        raise "Unknown source #{source}"
+      end
+    end
+
+    def parse_opts(args)
+      Hash[(args.map { |item| item.split(':') })]
+    end
+
+    def read_opts_from_json(path)
+      raise 'File not found' unless File.exist?(path)
+      JSON.parse(IO.read(path))
+    end
+
+    def generate(path, opts = {})
+      new_file_path = File.join(current_dir, File.basename(path))
+      File.write(new_file_path, provider.get(path, data: opts).source)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    private
+
+    def current_dir
+      Dir.pwd
+    end
+
+    def provider
+      @provider ||= RenderingEngine::Provider.new(file_repo)
+    end
+
+    def file_repo
+      @file_repo ||= RenderingEngine::FileRepo.new(base_path)
+    end
+
+    def base_path
+      @base_path ||= configuration.get.fetch(:repository).fetch(:place)
+    rescue
+      raise 'Repository configuration error. Check your configuration.'
+    end
+  end
+end

data/lib/dogen/configuration.rb

@@ -0,0 +1,41 @@
+require 'yaml'
+require 'hashie'
+
+module Dogen
+  class Configuration
+    class SetConfigError < StandardError; end
+
+    CONFIG_FILE_NAME = '.dogenrc'
+
+    def get
+      File.exist?(config_file) ? load_configuration : {}
+    end
+
+    def set(hash)
+      raise SetConfigError, 'argument is not kind of hash' unless hash.kind_of?(Hash)
+      updated_config = get.merge(hash)
+
+      save_configuration(updated_config)
+    end
+
+    def clear
+      File.write(config_file, {}.to_yaml)
+    end
+
+    private
+
+    def save_configuration(config)
+      File.write(config_file, config.to_yaml)
+    end
+
+    def load_configuration
+      Hashie::Mash.new(YAML.load_file(config_file))
+    rescue
+      {}
+    end
+
+    def config_file
+      File.expand_path(CONFIG_FILE_NAME, Dir.home)
+    end
+  end
+end

data/lib/dogen/description.rb

@@ -0,0 +1,3 @@
+module Dogen
+  DESCRIPTION = 'Documents generator for bash'
+end

data/lib/dogen/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'bundler/setup'
+require 'awesome_print'
+Bundler.setup
+
+require 'coveralls'
+Coveralls.wear!
+
+require 'dogen'
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  config.profile_examples = 10
+  config.order = :random
+
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/unit/lib/base_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe Dogen::Base do
+  subject { described_class.new }
+  context '#set_repository' do
+    let(:source)    { 'path' }
+    let(:place)     { '/home/user/repository' }
+    let(:repo_hash) { { repository: { source: source, place: place} } }
+    let(:repo_args) { ["#{source}::#{place}"] }
+
+    it 'save repository configuration' do
+      expect(File).to receive(:directory?).and_return(true)
+      expect(subject.configuration).to receive(:set).with(repo_hash)
+      subject.set_repository(repo_args)
+    end
+
+    it 'raise error when repositor directory is missing' do
+      expect(File).to receive(:directory?).and_return(false)
+      expect { subject.set_repository(repo_args) }.to raise_error
+    end
+
+    context 'when source is unknown' do
+      let(:source) { 'db' }
+      it 'raise error' do
+        expect { subject.set_repository(repo_args) }.to raise_error
+      end
+    end
+  end
+
+  it '#configuration' do
+    expect(subject.configuration).to be_a Dogen::Configuration
+  end
+
+  context '#parse_opts' do
+    let(:name)  { 'pawel niemczyk' }
+    let(:email) { 'pniemczyk@o2.pl' }
+    let(:args)  { ["name:#{name}", "email:#{email}"] }
+    let(:opts)  { { 'name' => name, 'email' => email } }
+
+    it 'return hash with options' do
+      expect(subject.parse_opts(args)).to eq opts
+    end
+  end
+
+  context '#read_opts_from_json' do
+    it 'raise error when file missing' do
+      expect(File).to receive(:exist?).and_return(false)
+      expect{ subject.read_opts_from_json('test_file') }.to raise_error
+    end
+
+    let(:source_file) { '{"name":"pawel niemczyk", "email":"pniemczyk@o2.pl"}' }
+    let(:hash)        { {'name' => 'pawel niemczyk', 'email' => 'pniemczyk@o2.pl'} }
+
+    it 'return json' do
+      expect(File).to receive(:exist?).and_return(true)
+      expect(IO).to receive(:read).and_return(source_file)
+      expect(subject.read_opts_from_json('test_file')).to eq hash
+    end
+  end
+
+  context '#generate' do
+    let(:pwd)      { '/home' }
+    let(:path)     { 'txt/file.txt' }
+    let(:new_path) { File.join(pwd, File.basename(path)) }
+    let(:opts)     { { 'name' => 'pawel'} }
+    let(:document) { double('document') }
+    let(:source)   { 'User name is pawel %>' }
+    let(:config)   { { repository: { place: 'some_path' } } }
+
+    it 'generate file in current directory' do
+      expect(Dir).to receive(:pwd).and_return(pwd)
+      expect(subject.configuration).to receive(:get).and_return(config)
+      expect(subject.send(:provider)).to receive(:get)
+                                         .with(path, data: opts)
+                                         .and_return(document)
+      expect(document).to receive(:source).and_return(source)
+      expect(File).to receive(:write).with(new_path, source)
+      subject.generate(path, opts)
+    end
+
+  end
+end
+

data/spec/unit/lib/configuration_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Dogen::Configuration do
+  let(:file_name)        { '.dogenrc' }
+  let(:home_path)        { '/home/user' }
+  let(:config_file_path) { "#{home_path}/#{file_name}" }
+  subject { described_class.new }
+
+  it 'CONFIG_FILE_NAME' do
+    expect(described_class::CONFIG_FILE_NAME).to eq file_name
+  end
+
+  context '#get' do
+    let(:config_hash) { { test: 1 } }
+    before do
+      expect(Dir).to receive(:home)
+                     .at_least(1).times
+                     .and_return(home_path)
+    end
+
+    it 'returns empty Hash when config file missing' do
+      expect(File).to receive(:exist?).with(config_file_path).and_return(false)
+      expect(subject.get).to eq Hash.new
+    end
+
+    it ' returns configuration as Hash when config file is present' do
+      expect(File).to receive(:exist?).with(config_file_path).and_return(true)
+      expect(YAML).to receive(:load_file)
+                      .with(config_file_path)
+                      .and_return(config_hash)
+      expect(subject.get).to eq Hashie::Mash.new(config_hash)
+    end
+  end
+
+  context '#set' do
+    it 'raise SetConfigError when argument is not kind of Hash' do
+      expect { subject.set('try') }.to raise_error
+    end
+
+    let(:config)           { Hashie::Mash.new(test: 1) }
+    let(:config_to_update) { { test: 2, new_one: 1 } }
+    let(:congig_yml)       { Hashie::Mash.new(config_to_update).to_yaml }
+
+    it 'update configuration by merge hashies' do
+      expect(Dir).to receive(:home).and_return(home_path)
+      expect(subject).to receive(:get).and_return(config)
+      expect(File).to receive(:write).with(config_file_path, congig_yml)
+      subject.set(config_to_update)
+    end
+  end
+
+  it '#clear' do
+    expect(Dir).to receive(:home).and_return(home_path)
+    expect(File).to receive(:write).with(config_file_path, {}.to_yaml)
+    subject.clear
+  end
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: dogen
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pawel Niemczyk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: commander
+  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: rendering_engine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: guard-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: coveralls
+  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'
+description: Documents generator for bash
+email:
+- pniemczyk@o2.pl
+executables:
+- dogen
+- test.txt
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/dogen
+- bin/test.txt
+- dogen.gemspec
+- lib/dogen.rb
+- lib/dogen/base.rb
+- lib/dogen/configuration.rb
+- lib/dogen/description.rb
+- lib/dogen/version.rb
+- spec/spec_helper.rb
+- spec/unit/lib/base_spec.rb
+- spec/unit/lib/configuration_spec.rb
+homepage: https://github.com/pniemczyk/dogen
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Documents generator for bash
+test_files:
+- spec/spec_helper.rb
+- spec/unit/lib/base_spec.rb
+- spec/unit/lib/configuration_spec.rb
+has_rdoc: