fedux_org-stdlib 0.0.33 → 0.0.35

data/Gemfile

@@ -2,6 +2,9 @@ source 'https://rubygems.org'
 
 gemspec 
 
+gem 'launchy'
+gem 'command_exec'
+
 group :test do
   gem 'rake'
   gem 'rspec'

data/lib/fedux_org/stdlib.rb

@@ -7,5 +7,9 @@ require 'fedux_org/stdlib/models'
 require 'fedux_org/stdlib/version'
 
 module FeduxOrg
-  module Stdlib; end
+  module Stdlib 
+    def self.root_directory
+      File.expand_path( '../../..', __FILE__ )
+    end
+  end
 end

data/lib/fedux_org/stdlib/environment.rb

@@ -4,25 +4,27 @@ module FeduxOrg
 
       # Set environment variable for code block
       #
-      # @param [Hash] variables
+      # @param [Hash] new_environment_variables
       #   the variables which should be set for that environment
       #
+      # @param [Hash] options
+      #   options for environment manipulation
+      #
+      # @option options [True,False] :clear
+      #   Should the environment clear before merge? 
+      #
       # @yield
       #   the block which should be run which the change environment
-      def isolated_environment(variables, &block)
-        #backup
-        old_env = ENV.to_hash
-        #change env
-        ENV.update variables
+      def isolated_environment(new_environment_variables, options={}, &block)
+        old_environment = ENV.to_hash
 
-        block_result = block.call
+        ENV.clear if options[:clear] == true
+        ENV.update new_environment_variables
 
-        #cleanup
+        block.call
+      ensure
         ENV.clear 
-        #install backuped information
-        ENV.update old_env
-
-        block_result
+        ENV.update old_environment
       end
     end
   end

data/lib/fedux_org/stdlib/project.rb

@@ -0,0 +1,5 @@
+require 'fedux_org/stdlib/project/logger'
+require 'fedux_org/stdlib/project/plan'
+require 'fedux_org/stdlib/project/report'
+require 'fedux_org/stdlib/project/generators/taskjuggler'
+

data/lib/fedux_org/stdlib/project/generators/taskjuggler.rb

@@ -0,0 +1,28 @@
+require 'fedux_org/stdlib/logging/logger'
+
+begin
+  require 'command_exec'
+rescue LoadError => e
+  $stderr.puts "You need to install the following gems to make it work: \"command_exec\"."
+  exit 1
+end
+
+module FeduxOrg
+  module Stdlib
+    module Project
+      module Generators
+
+        class Taskjuggler
+          def generate_report( directory, plan_file )
+            FeduxOrg::Stdlib::Project.logger.debug "Start generating report."
+            CommandExec::Command.new( :tj3 , :parameter => "-o #{directory} #{plan_file}" ).run
+            FeduxOrg::Stdlib::Project.logger.info "Generating report succeeded."
+          rescue Exception => e
+            FeduxOrg::Stdlib::Project.logger.fatal "Generating report failed. Maybe you forgot to install \"the taskjuggler\"-gem or it is not available in PATH? The error message was: #{e.message}"
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/fedux_org/stdlib/project/logger.rb

@@ -0,0 +1,13 @@
+require 'fedux_org/stdlib/logging/logger'
+
+module FeduxOrg
+  module Stdlib
+    module Project
+      class << self
+        def logger
+          @logger ||= FeduxOrg::Stdlib::Logging::Logger.new
+        end
+      end
+    end
+  end
+end

data/lib/fedux_org/stdlib/project/plan.rb

@@ -0,0 +1,15 @@
+module FeduxOrg
+  module Stdlib
+
+    module Project
+      class Plan
+        attr_reader :file
+
+        def initialize(file = File.expand_path( '../plan.tjp', __FILE__ ) )
+          @file = file
+        end
+      end
+
+    end
+  end
+end

data/lib/fedux_org/stdlib/project/report.rb

@@ -0,0 +1,67 @@
+require 'fedux_org/stdlib/logging/logger'
+require 'fedux_org/stdlib/project/logger'
+require 'fedux_org/stdlib/project/generators/taskjuggler'
+
+require 'fileutils'
+
+begin
+  require 'launchy'
+rescue LoadError => e
+  $stderr.puts "You need to install the following gems to make it work: \"launchy\"."
+  exit 1
+end
+
+module FeduxOrg
+  module Stdlib
+    module Project
+
+      class Report
+        attr_reader :directory, :file
+
+        def initialize( plan, generator = FeduxOrg::Stdlib::Project::Generators::Taskjuggler.new,
+                              output_directory = File.join( Dir.getwd, 'reports' ),
+                              output_file = nil
+                      )
+          @plan = plan
+          @output_directory = output_directory
+          @output_file      = case output_file 
+                              when nil
+                                File.join( @output_directory, 'Overview.html' )
+                              else
+                                output_file
+                              end
+          @generator = generator
+        end
+
+        def generate
+          prepare_environment
+
+          if output_file_exists? and plan_is_newer_than_output_file?
+            FeduxOrg::Stdlib::Project.logger.warn "No need to re-generate report. The plan file \"#{@plan.file}\" is NOT newer than output \"#{@output_file}\"."
+          else
+            @generator.generate_report( @output_directory, @plan.file ) 
+          end
+        end
+
+        def open
+          Launchy.open( @output_file )
+        end
+
+        private
+
+        def prepare_environment
+          FileUtils.mkdir_p @output_directory
+        end
+
+        def output_file_exists?
+          File.exists? @output_file
+        end
+
+        def plan_is_newer_than_output_file?
+          File.mtime( @output_file ) > File.mtime( @plan.file)
+        end
+      end
+
+    end
+  end
+end

data/lib/fedux_org/stdlib/rake/project.rb

@@ -0,0 +1,18 @@
+require 'fedux_org/stdlib/project'
+
+namespace :report do
+
+  plan   = FeduxOrg::Stdlib::Project::Plan.new
+  report = FeduxOrg::Stdlib::Project::Report.new( plan )
+
+  desc "Generate report"
+  task :generate do
+    report.generate
+  end
+
+  desc "Show report"
+  task :show => :generate do
+    report.open
+  end
+
+end

data/lib/fedux_org/stdlib/version.rb

@@ -1,6 +1,6 @@
 #main FeduxOrg
 module FeduxOrg
 module Stdlib
-  VERSION = '0.0.33'
+  VERSION = '0.0.35'
 end
 end

data/spec/environment_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe FeduxOrg::Stdlib::Environment do
+  context '#isolated_environment' do
+    it 'runs command in isolated environment' do
+      klass = Class.new do
+        include FeduxOrg::Stdlib::Environment 
+
+        def test_env
+          isolated_environment 'TEST_VAR' => 'this is a test' do
+            ENV['TEST_VAR']
+          end
+        end
+      end
+
+      expect( klass.new.test_env ).to eq( 'this is a test' )
+    end
+
+    it 'let you define an environment before running a command' do
+      klass = Class.new do
+        include FeduxOrg::Stdlib::Environment 
+
+        def test_env
+          isolated_environment( {}, { clear: true } ) do
+
+            #are set by the terminal and can hardly be cleared
+            ENV.delete( 'COLUMNS' )
+            ENV.delete( 'LINES' )
+
+            ENV.to_hash
+          end
+        end
+      end
+
+      expect( klass.new.test_env ).to eq( {} )
+    end
+
+    it 'restores environment although an exception occured' do
+      klass = Class.new do
+        include FeduxOrg::Stdlib::Environment 
+
+        def test_env
+          ENV['TEST_VAR'] = 'TEST'
+
+          begin
+            isolated_environment( {}, { clear: true } ) do
+              raise
+            end
+          rescue
+          end
+
+          ENV['TEST_VAR']
+        end
+      end
+
+      expect( klass.new.test_env ).to eq( 'TEST' )
+    end
+  end
+end

data/spec/project/plan_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+require 'fedux_org/stdlib/project/plan'
+
+describe FeduxOrg::Stdlib::Project::Plan do
+end

data/spec/project/report_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'fedux_org/stdlib/project/report'
+require 'fedux_org/stdlib/filesystem'
+
+describe FeduxOrg::Stdlib::Project::Report do
+  context '#generate' do
+
+    it 'generates report' do
+      plan = double( 'Plan' )
+      allow( plan ).to receive( :file ).and_return { create_file( 'plan.tjp' ) }
+
+      generator = double( 'Generator' )
+      expect( generator ).to receive( :generate_report )
+
+      report = FeduxOrg::Stdlib::Project::Report.new( plan, generator )
+      report.generate
+    end
+
+    it 'generates report only if plan file is newer than output file' do
+      plan_file   = create_file( 'plan.tjp' ) 
+      report_file = create_file( 'reports/Overview.html' )
+
+      FileUtils.touch report_file, :mtime => Time.now - 2.hours
+
+      plan = double( 'Plan' )
+      allow( plan ).to receive( :file ).and_return {plan_file }
+
+      generator = double( 'Generator' )
+      expect( generator ).to receive( :generate_report ).once
+
+      switch_to_working_directory do
+        report = FeduxOrg::Stdlib::Project::Report.new( plan, generator )
+        report.generate
+      end
+    end
+
+    it 'does not generate report if plan file is older or of eqal age than output file' do
+      plan_file   = create_file( 'plan.tjp' ) 
+      report_file = create_file( 'reports/Overview.html' )
+
+      FileUtils.touch plan_file, :mtime => Time.now - 2.hours
+
+      plan = double( 'Plan' )
+      allow( plan ).to receive( :file ).and_return { plan_file }
+
+      generator = double( 'Generator' )
+
+      switch_to_working_directory do
+        report = FeduxOrg::Stdlib::Project::Report.new( plan, generator )
+        silence( :stderr ) do
+          report.generate
+        end
+      end
+    end
+  end
+
+  context '#open' do
+    it 'can open a report in a browser' do
+      plan = double( 'Plan' )
+      generator = double( 'Generator' )
+      report = FeduxOrg::Stdlib::Project::Report.new( plan, generator )
+
+      expect(
+        report.respond_to? :open
+      ).to be_true
+    end
+  end
+end

data/spec/project/taskjuggler_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+require 'fedux_org/stdlib/project/generators/taskjuggler'
+
+describe FeduxOrg::Stdlib::Project::Generators::Taskjuggler do
+end

data/spec/spec_helper.rb

@@ -27,4 +27,18 @@ def examples_dir
   File.expand_path( '../examples', __FILE__ )
 end
 
+
+require 'fedux_org/stdlib/filesystem'
+include FeduxOrg::Stdlib::Filesystem
+
+def root_directory
+  FeduxOrg::Stdlib.root_directory 
+end
+
+RSpec.configure do |c|
+  c.before( :each ) do
+    cleanup_working_directory
+  end
+end
+
 require 'active_support/core_ext/kernel/reporting'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fedux_org-stdlib
 version: !ruby/object:Gem::Version
-  version: 0.0.33
+  version: 0.0.35
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-08 00:00:00.000000000 Z
+date: 2013-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,6 +102,11 @@ files:
 - lib/fedux_org/stdlib/models/class_based_model.rb
 - lib/fedux_org/stdlib/models/exceptions.rb
 - lib/fedux_org/stdlib/models/filesystem_based_model.rb
+- lib/fedux_org/stdlib/project.rb
+- lib/fedux_org/stdlib/project/generators/taskjuggler.rb
+- lib/fedux_org/stdlib/project/logger.rb
+- lib/fedux_org/stdlib/project/plan.rb
+- lib/fedux_org/stdlib/project/report.rb
 - lib/fedux_org/stdlib/rake.rb
 - lib/fedux_org/stdlib/rake/console.rb
 - lib/fedux_org/stdlib/rake/documentation.rb
@@ -110,6 +115,7 @@ files:
 - lib/fedux_org/stdlib/rake/gems/bundler.rb
 - lib/fedux_org/stdlib/rake/gems/package.rb
 - lib/fedux_org/stdlib/rake/library.rb
+- lib/fedux_org/stdlib/rake/project.rb
 - lib/fedux_org/stdlib/rake/terminal.rb
 - lib/fedux_org/stdlib/rake/tests.rb
 - lib/fedux_org/stdlib/rake/tests/cucumber.rb
@@ -129,6 +135,7 @@ files:
 - script/terminal
 - spec/colors/html_color_spec.rb
 - spec/command_spec.rb
+- spec/environment_spec.rb
 - spec/examples/models/class_based/forbidden_keyword.rb
 - spec/examples/models/class_based/ignore/ignored.rb
 - spec/examples/models/class_based/ignore/valid_1.rb
@@ -147,6 +154,9 @@ files:
 - spec/models/base_model_spec.rb
 - spec/models/class_based_model_spec.rb
 - spec/models/filesystem_based_model_spec.rb
+- spec/project/plan_spec.rb
+- spec/project/report_spec.rb
+- spec/project/taskjuggler_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -176,6 +186,7 @@ summary: collection of useful libraries
 test_files:
 - spec/colors/html_color_spec.rb
 - spec/command_spec.rb
+- spec/environment_spec.rb
 - spec/examples/models/class_based/forbidden_keyword.rb
 - spec/examples/models/class_based/ignore/ignored.rb
 - spec/examples/models/class_based/ignore/valid_1.rb
@@ -194,5 +205,8 @@ test_files:
 - spec/models/base_model_spec.rb
 - spec/models/class_based_model_spec.rb
 - spec/models/filesystem_based_model_spec.rb
+- spec/project/plan_spec.rb
+- spec/project/report_spec.rb
+- spec/project/taskjuggler_spec.rb
 - spec/spec_helper.rb
 has_rdoc: