middleman-build-reporter 0.0.1

data/spec/middleman-build-reporter/reporter_spec.rb

@@ -0,0 +1,184 @@
+require 'spec_helper'
+
+describe Middleman::BuildReporter::Reporter do
+
+  let(:git_repo) { Git.open('.') }
+
+  let(:fake_details) { { 'foo' => 'bar' } }
+
+  let(:app) { middleman_app('basic-app') }
+
+  let(:reporter) do
+    app.set :repo_root, '.'
+    app.set :version, '1.2.3'
+    app.set :reporter_file, 'reporter'
+    app.set :reporter_file_formats, ['yaml']
+
+    described_class.new app
+  end
+
+  describe '#new' do
+
+    it 'sets an attr_accessor\'d @app instance variable to the value of the app it is passed' do
+      expect(reporter.app).to eq app
+    end
+
+    it 'sets a #repo on the app instance it is passed' do
+      expect(reporter.app.repo.class).to eq Git::Base
+    end
+  end
+
+  describe '#write' do
+
+    it 'writes the build details to the proper "build" file' do
+      allow(reporter).to receive(:details).and_return fake_details
+      allow(reporter.app).to receive(:reporter_file).and_return 'fake_report_file'
+
+      expect(File).to receive(:write).with('build/fake_report_file.yaml', "---\nfoo: bar\n").and_return 'fake_write_call'
+
+      reporter.write
+    end
+  end
+
+  describe '#reporter_file_path' do
+
+    it 'returns the file path to which the build details should be written' do
+      expect(reporter.reporter_file_path).to eq 'build/reporter'
+    end
+  end
+
+  describe '#reporter_extension_path' do
+
+    it 'returns the file path to ".build_reporter.yml" file' do
+      expect(reporter.reporter_extension_file_path).to eq "#{app.root}/.build_reporter.yml"
+    end
+  end
+
+  describe '#details' do
+
+    before do
+      Timecop.travel Time.now
+    end
+
+    after do
+      Timecop.return
+    end
+
+    let(:details) { reporter.details }
+
+    context 'the build details hash it returns' do
+
+      it 'reports the git branch' do
+        expect(details['branch']).to eq "#{git_repo.current_branch}"
+      end
+
+      it 'reports the git revision' do
+        expect(details['revision']).to eq "#{git_repo.log.first}"
+      end
+
+      it 'reports the build time' do
+        expect(details['build_time']).to eq "#{Time.now}"
+      end
+
+      it 'reports the app version' do
+        expect(details['version']).to eq "#{app.version}"
+      end
+
+      context 'when there is a custom details extension' do
+        before do
+          allow(reporter).to receive(:details_extension).and_return 'foo' => 'bar'
+        end
+
+        it 'includes the additional details in the hash it returns' do
+          expect(details['foo']).to eq 'bar'
+        end
+      end
+    end
+  end
+
+  describe '#details_extension' do
+
+    context 'when there is no ".build_reporter.yml" file in the root of the project' do
+
+      it 'returns an empty hash' do
+        expect(reporter.details_extension).to eq({})
+      end
+    end
+
+    context 'when there is a ".build_reporter.yml" file in the root of the project' do
+
+      it 'returns a hash representation of its YAML' do
+        allow(reporter).to receive(:details_extension_exist?).and_return true
+        allow(File).to receive(:read).with("#{app.root}/.build_reporter.yml").and_return "---\nsome_key: 'some value'\n"
+
+        expect(reporter.details_extension).to eq('some_key' => 'some value')
+      end
+    end
+  end
+
+  describe '#details_extension_exist?' do
+
+    context 'when there is no ".build_reporter.yml" in the project root' do
+
+      it 'returns false' do
+        expect(reporter.details_extension_exist?).to eq false
+      end
+    end
+
+    context 'when there is a ".build_reporter.yml" in the project root' do
+
+      it 'returns true' do
+        allow(File).to receive(:exist?).with(reporter.reporter_extension_file_path).and_return true
+
+        expect(reporter.details_extension_exist?).to eq true
+      end
+    end
+  end
+
+  describe '#build_time' do
+
+    it 'reports the current time' do
+      expect(reporter.build_time.strftime('%Y-%m-%d %H:%M')).to eq Time.now.strftime('%Y-%m-%d %H:%M')
+    end
+
+    context 'when build time is already set' do
+      it 'returns the existing value' do
+        reporter.instance_variable_set('@build_time', 'foo')
+
+        expect(reporter.build_time).to eq 'foo'
+      end
+    end
+  end
+
+  describe '#repo' do
+
+    it 'is a shortcut to app#repo' do
+      expect(reporter.repo).to eq app.repo
+    end
+  end
+
+  describe '#serialize' do
+
+    before do
+      allow(reporter).to receive(:details).and_return fake_details
+    end
+
+    context 'when it is passed "json"' do
+
+      let(:json) { JSON.parse(reporter.serialize('json')) }
+
+      it 'returns the build details as a JSON object' do
+        expect(json['foo']).to eq 'bar'
+      end
+    end
+
+    context 'when it is passed "yaml"' do
+
+      let(:yaml) { YAML.load(reporter.serialize('yaml')) }
+
+      it 'returns the build details as a JSON object' do
+        expect(yaml['foo']).to eq 'bar'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'bundler/setup'
+require 'git'
+
+Bundler.require(:development)
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__), 'support', '**', '*.rb'))].each { |f| require f }
+
+SimpleCov.start
+
+require 'middleman-build-reporter'
+require 'middleman-build-reporter/extension'
+
+def middleman_app(fixture_path)
+  root_dir = File.expand_path("../../fixtures/#{fixture_path}", __FILE__)
+
+  if File.exist?(File.join(root_dir, 'source'))
+    ENV['MM_SOURCE'] = 'source'
+  else
+    ENV['MM_SOURCE'] = ''
+  end
+
+  initialize_commands = @initialize_commands || []
+
+  initialize_commands.unshift lambda {
+    set :root, root_dir
+    set :environment, :development
+    set :show_exceptions, false
+  }
+
+  Middleman::Application.server.inst do
+    initialize_commands.each do |p|
+      instance_exec(&p)
+    end
+  end
+end

metadata

@@ -0,0 +1,248 @@
+--- !ruby/object:Gem::Specification
+name: middleman-build-reporter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mike Ball
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  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: git
+  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: 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: simplecov
+  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: timecop
+  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: cucumber
+  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: aruba
+  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: fivemat
+  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: 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'
+description: Report build time details within your Middleman build
+email:
+- mikedball@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- features/build_reporter.feature
+- features/custom_build_reporter_file_name.feature
+- features/extended_build_reporter.feature
+- features/json_build_reporter.feature
+- features/no_explicit_version.feature
+- features/step_definitions/git_steps.rb
+- features/step_definitions/json_reporter_file_steps.rb
+- features/step_definitions/version_steps.rb
+- features/support/env.rb
+- features/support/helpers.rb
+- fixtures/basic-app/config.rb
+- fixtures/basic-app/source/images/background.png
+- fixtures/basic-app/source/images/middleman.png
+- fixtures/basic-app/source/index.html.erb
+- fixtures/basic-app/source/javascripts/all.js
+- fixtures/basic-app/source/layouts/layout.erb
+- fixtures/basic-app/source/stylesheets/all.css
+- fixtures/basic-app/source/stylesheets/normalize.css
+- fixtures/custom-reporter-file-name/config.rb
+- fixtures/custom-reporter-file-name/source/images/background.png
+- fixtures/custom-reporter-file-name/source/images/middleman.png
+- fixtures/custom-reporter-file-name/source/index.html.erb
+- fixtures/custom-reporter-file-name/source/javascripts/all.js
+- fixtures/custom-reporter-file-name/source/layouts/layout.erb
+- fixtures/custom-reporter-file-name/source/stylesheets/all.css
+- fixtures/custom-reporter-file-name/source/stylesheets/normalize.css
+- fixtures/extended-build-reporter/.build_reporter.yml
+- fixtures/extended-build-reporter/config.rb
+- fixtures/extended-build-reporter/source/images/background.png
+- fixtures/extended-build-reporter/source/images/middleman.png
+- fixtures/extended-build-reporter/source/index.html.erb
+- fixtures/extended-build-reporter/source/javascripts/all.js
+- fixtures/extended-build-reporter/source/layouts/layout.erb
+- fixtures/extended-build-reporter/source/stylesheets/all.css
+- fixtures/extended-build-reporter/source/stylesheets/normalize.css
+- fixtures/json-reporter-file/config.rb
+- fixtures/json-reporter-file/source/images/background.png
+- fixtures/json-reporter-file/source/images/middleman.png
+- fixtures/json-reporter-file/source/index.html.erb
+- fixtures/json-reporter-file/source/javascripts/all.js
+- fixtures/json-reporter-file/source/layouts/layout.erb
+- fixtures/json-reporter-file/source/stylesheets/all.css
+- fixtures/json-reporter-file/source/stylesheets/normalize.css
+- fixtures/no-version/config.rb
+- fixtures/no-version/source/images/background.png
+- fixtures/no-version/source/images/middleman.png
+- fixtures/no-version/source/index.html.erb
+- fixtures/no-version/source/javascripts/all.js
+- fixtures/no-version/source/layouts/layout.erb
+- fixtures/no-version/source/stylesheets/all.css
+- fixtures/no-version/source/stylesheets/normalize.css
+- lib/middleman-build-reporter.rb
+- lib/middleman-build-reporter/extension.rb
+- lib/middleman-build-reporter/reporter.rb
+- lib/middleman-build-reporter/version.rb
+- lib/middleman_extension.rb
+- middleman-build-reporter.gemspec
+- spec/middleman-build-reporter/extension_spec.rb
+- spec/middleman-build-reporter/reporter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mdb/middleman-build-reporter
+licenses: []
+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: Report build time details within your Middleman build
+test_files:
+- features/build_reporter.feature
+- features/custom_build_reporter_file_name.feature
+- features/extended_build_reporter.feature
+- features/json_build_reporter.feature
+- features/no_explicit_version.feature
+- features/step_definitions/git_steps.rb
+- features/step_definitions/json_reporter_file_steps.rb
+- features/step_definitions/version_steps.rb
+- features/support/env.rb
+- features/support/helpers.rb
+- spec/middleman-build-reporter/extension_spec.rb
+- spec/middleman-build-reporter/reporter_spec.rb
+- spec/spec_helper.rb
+has_rdoc: