document_generator 0.0.2

data/spec/lib/document_generator/repository_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+require 'fileutils'
+
+module DocumentGenerator
+  describe Repository do
+    let(:url) { 'https://github.com/stevenhallen/document_generator.git' }
+    let(:repository) { Repository.new(url) }
+
+    describe '.menu_relative_filename' do
+      it 'is _includes/menu.md' do
+        expect(Repository.menu_relative_filename).to eq '_includes/menu.md'
+      end
+    end
+
+    describe '#base_url' do
+      let(:expected) { 'https://github.com/stevenhallen/document_generator/' }
+
+      context 'when the url is a git url that is read-only' do
+        let(:url) { 'git://github.com/stevenhallen/document_generator.git' }
+
+        it 'is the https url without the .git' do
+          expect(repository.base_url).to eq expected
+        end
+      end
+
+      context 'when the url is a git url that is read-write' do
+        let(:url) { 'git@github.com:stevenhallen/document_generator.git' }
+
+        it 'is the https url without the .git' do
+          expect(repository.base_url).to eq expected
+        end
+      end
+
+      context 'when the url is a http url' do
+        let(:url) { 'http://github.com/stevenhallen/document_generator.git' }
+
+        it 'is the https url without the .git' do
+          expect(repository.base_url).to eq expected
+        end
+      end
+    end
+
+    describe '#name' do
+      let(:url) { 'https://github.com/stevenhallen/document_generator.git' }
+
+      it 'is the last path segment from the normalized uri' do
+        expect(repository.name).to eq 'document_generator'
+      end
+    end
+
+    describe '#generate' do
+      let(:url) { 'https://github.com/stevenhallen/rails_getting_started_bdd.git' }
+
+      let(:docs) { Dir.glob(File.expand_path('../../../../*.md', __FILE__)) }
+      let(:root) { File.expand_path('../../../../.', __FILE__) }
+      let(:layouts) { File.expand_path('../../../../_layouts', __FILE__) }
+
+      before do
+        FileUtils.rmtree(layouts) if Dir.exists?(layouts)
+        FileUtils.rm(docs)
+
+        Dir.mkdir(layouts)
+      end
+
+      it 'creates files in the root folder' do
+        expect { repository.generate }.to change { Dir.entries(root) }
+      end
+
+      it 'creates files in the layouts folder' do
+        expect { repository.generate }.to change { Dir.entries(layouts) }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'simplecov'
+require 'json'
+
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+require 'rspec'
+require 'rspec/fire'
+
+require 'document_generator'
+
+RSpec.configure do |config|
+  config.include(RSpec::Fire)
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run focused: true
+  config.alias_example_to :fit, focused: true
+  config.alias_example_to :pit, pending: true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: document_generator
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- wiscoDude
+- m5rk
+- stevenhallen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: git
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rspec-fire
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: |
+  Generate documentation from a git repository.
+email:
+- philip@stevenhallen.com
+- mark@stevenhallen.com
+executables:
+- doc_generate
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- _layouts/default.html
+- assets/_layouts/default.html
+- bin/doc_generate
+- coderay.css
+- document_generator.gemspec
+- index.md
+- lib/document_generator.rb
+- lib/document_generator/cli.rb
+- lib/document_generator/commit.rb
+- lib/document_generator/diff_file.rb
+- lib/document_generator/output.rb
+- lib/document_generator/repository.rb
+- lib/document_generator/version.rb
+- spec/lib/document_generator/cli_spec.rb
+- spec/lib/document_generator/commit_spec.rb
+- spec/lib/document_generator/diff_file_spec.rb
+- spec/lib/document_generator/repository_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/stevenhallen/document_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.0.6
+signing_key: 
+specification_version: 4
+summary: Generate documentation from a git repository.
+test_files:
+- spec/lib/document_generator/cli_spec.rb
+- spec/lib/document_generator/commit_spec.rb
+- spec/lib/document_generator/diff_file_spec.rb
+- spec/lib/document_generator/repository_spec.rb
+- spec/spec_helper.rb