fedux_org-stdlib 0.3.2 → 0.6.3

data/lib/fedux_org_stdlib/rake/sub_task.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/rake/task'
+
+module FeduxOrgStdlib
+  module Rake
+    # Sub Task
+    #
+    # @see Rakefile
+    class SubTask < Task
+      # @!attribute [r] command
+      #   The command to be executed
+      attr_reader :sub_tasks
+
+      def initialize(sub_tasks:, **args)
+        super(**args)
+
+        @sub_tasks = Array(sub_tasks)
+      end
+
+      # @private
+      def run_task(verbose)
+        sub_tasks.each { |t| ::Rake::Task[t].invoke }
+      end
+    end
+  end
+end

data/lib/fedux_org_stdlib/rake/task.rb

@@ -0,0 +1,118 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/require_files'
+require_library %w{ json rake rake/tasklib shellwords active_support/core_ext/object/blank active_support/core_ext/string/inflections}
+
+require 'fedux_org_stdlib/rake/exceptions'
+require 'fedux_org_stdlib/logging/logger'
+
+module FeduxOrgStdlib
+  module Rake
+    # Rake Task
+    #
+    # @see Rakefile
+    class Task < ::Rake::TaskLib
+      include ::Rake::DSL if defined?(::Rake::DSL)
+
+      # @!attribute [r] name
+      #   Name of task.
+      attr_reader :name
+
+      # @!attribute [r] description
+      #   A description for the task
+      attr_reader :description
+
+      # @!attribute [r] verbose (true)
+      #   Use verbose output. If this is set to true, the task will print the
+      #   executed spec command to stdout.
+      attr_reader :verbose
+
+      private
+
+      attr_reader :task_arguments, :task_block, :logger, :working_directory
+
+      # Create task instance
+      def initialize(description:, name: self.class.to_s.split(/::/).slice(-2..-1).join(':').gsub(/Task$/, '').underscore, arguments: [], define_in_ci_mode: true, activate_ci_mode: false, dependencies: [], &task_block)
+        before_initialize
+
+        @description        = description
+        @task_arguments     = Array(arguments)
+        @task_block         = task_block
+        @logger             = FeduxOrgStdlib::Logging::Logger.new
+        @working_directory  = Dir.getwd
+        @activate_ci_mode   = activate_ci_mode
+
+        if dependencies.blank? 
+          @name = name
+        else
+          @name = {
+            name: Array(dependencies).map(&:to_sym)
+          }
+        end
+
+        after_initialize
+
+        define_task unless running_in_ci_mode?
+        define_task if define_in_ci_mode? and running_in_ci_mode?
+
+        activate_ci_mode if activate_ci_mode?
+      end
+
+      private
+
+      # Activate ci mode
+      def activate_ci_mode
+        ENV['CI'] = 'true'
+      end
+
+      # Run code after initialize
+      def after_initialize; end
+
+      # Run code before initialize
+      def before_initialize; end
+
+      # Define task
+      def define_task
+        desc description unless ::Rake.application.last_comment
+
+        task name, *task_arguments do |_, task_args|
+          RakeFileUtils.__send__(:verbose, verbose) do
+            task_block.call(*[self, task_args].slice(0, task_block.arity)) if task_block.respond_to? :call
+            run_task verbose
+          end
+        end
+      end
+
+      # Run code if task is executed
+      def run_task(verbose); end
+
+      # Should this task be defined in continous integration mode
+      def define_in_ci_mode?
+        @define_in_ci_mode == true
+      end
+
+      # Check if running in continous integration mode
+      def running_in_ci_mode?
+        ENV.key? 'CI'
+      end
+
+      # Check if continous integration mode is activated
+      def activate_ci_mode?
+        @activate_ci_mode == true
+      end
+
+      public
+
+      # Binding to instance
+      def get_binding
+        binding
+      end
+
+      # Include module in instance
+      def include(modules)
+        modules = Array(modules)
+
+        modules.each { |m| self.class.include m }
+      end
+    end
+  end
+end

data/lib/fedux_org_stdlib/rake/version_bump_task.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/version_management/rubygem_version_file'
+require 'fedux_org_stdlib/versionable'
+
+module FeduxOrgStdlib
+  module Rake
+    # Version Bump Task
+    #
+    # @see Rakefile
+    class VersionBumpTask < Task
+      include Versionable
+
+      # @private
+      def bump_version(type)
+        version_update do |file|
+          file.bump(type) 
+        end
+      end
+
+      # @private
+      def set_version(new_version)
+        raise Exception, "You need to define a version via \"VERSION=<version>\" or \"version=<version>\"." if new_version.blank?
+
+        begin
+          version_update do |file|
+            file.version = new_version
+          end
+        rescue StandardError => e
+          logger.fatal("Nothing has changed since your last commit or has been added to the index. Therefor nothing needs to be commited: #{e.message}.")
+        end
+      end
+
+      private
+
+      def add_to_repo(file, version)
+        logger.info('Adding new version file to repository.')
+
+        sh "git add #{file}"
+        sh "git commit -m 'Version bump to #{version}'"
+      end
+
+
+      def version_update(&block)
+        file = FeduxOrgStdlib::VersionManagement::RubygemVersionFile.read(version_file)
+        old_version = file.version
+        block.call(file)
+        new_version = file.version
+
+        file.write(version_file)
+
+        logger.info("Updated version. It was \"#{old_version}\". It is now \"#{new_version}\".")
+        add_to_repo(version_file, file.version)
+      end
+    end
+  end
+end

data/lib/fedux_org_stdlib/rake_tasks.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/rake_tasks/version'
+require 'fedux_org_stdlib/rake_tasks/documentation'
+require 'fedux_org_stdlib/rake_tasks/console'
+require 'fedux_org_stdlib/rake_tasks/terminal'
+require 'fedux_org_stdlib/rake_tasks/qa'
+require 'fedux_org_stdlib/rake_tasks/gems'
+require 'fedux_org_stdlib/rake_tasks/project'

data/lib/fedux_org_stdlib/rake_tasks/console.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/rake/shell_task'
+
+FeduxOrgStdlib::Rake::ShellTask.new(
+  name: 'console',
+  description: 'Start console with library loaded in advance',
+  use_bundler: true,
+  command: 'script/console',
+  define_in_ci_mode: false
+)
+

data/lib/fedux_org_stdlib/rake_tasks/documentation.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/rake_tasks/documentation/yard'

data/lib/fedux_org_stdlib/rake_tasks/documentation/yard.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/ci'
+
+unless ci?
+  require 'fedux_org_stdlib/require_files'
+  require_library %w{ yard }
+
+  YARD::Rake::YardocTask.new()
+end

data/lib/fedux_org_stdlib/rake_tasks/gems.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/rake_tasks/gems/bundler'
+require 'fedux_org_stdlib/rake_tasks/gems/package'

data/lib/fedux_org_stdlib/rake_tasks/gems/bundler.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/require_files'
+require 'fedux_org_stdlib/ci'
+
+unless ci?
+  namespace :gem do
+    require_library %w{ bundler/gem_tasks }
+  end
+end

data/lib/fedux_org_stdlib/rake_tasks/gems/package.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/require_files'
+require 'fedux_org_stdlib/ci'
+
+unless ci?
+  namespace :gem do
+    require_library %w{ rubygems/package_task }
+  end
+end

data/lib/fedux_org_stdlib/rake_tasks/project.rb

@@ -0,0 +1 @@
+require 'fedux_org_stdlib/rake_tasks/project/report'

data/lib/fedux_org_stdlib/rake_tasks/project/report.rb

@@ -0,0 +1,3 @@
+require 'fedux_org_stdlib/rake_tasks/project/report/open'
+require 'fedux_org_stdlib/rake_tasks/project/report/open_shortcut'
+require 'fedux_org_stdlib/rake_tasks/project/report/generate'

data/lib/fedux_org_stdlib/rake_tasks/project/report/generate.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/rake/project_task'
+
+FeduxOrgStdlib::Rake::ProjectTask.new(
+  name: 'project:report:generate',
+  description: 'Generate report for project plan',
+) do |t|
+  t.report.generate
+end
+

data/lib/fedux_org_stdlib/rake_tasks/project/report/open.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/rake/project_task'
+
+FeduxOrgStdlib::Rake::ProjectTask.new(
+  name: 'project:report:open',
+  description: 'Open generated report for project plan',
+) do |t|
+  require 'pry'
+  binding.pry
+  t.report.open
+end
+

data/lib/fedux_org_stdlib/rake_tasks/project/report/open_shortcut.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/rake/sub_task'
+require 'fedux_org_stdlib/rake_tasks/project/report/open'
+
+FeduxOrgStdlib::Rake::SubTask.new(
+  name: 'project:report',
+  description: 'Open report for generated project plan',
+  sub_tasks: %w{ project:report:open },
+)

data/lib/fedux_org_stdlib/rake_tasks/qa.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+
+require 'fedux_org_stdlib/rake_tasks/qa/travis'
+require 'fedux_org_stdlib/rake_tasks/qa/rubocop'

data/lib/fedux_org_stdlib/rake_tasks/qa/rubocop.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/rake/shell_task'
+
+require 'fedux_org_stdlib/require_files'
+require_installed_gem('rubocop')
+
+FeduxOrgStdlib::Rake::ShellTask.new(
+  name: 'qa:rubocop',
+  description: 'Run rubocop',
+  use_bundler: true,
+  command: 'rubocop',
+  define_in_ci_mode: false,
+)

data/lib/fedux_org_stdlib/rake_tasks/qa/travis.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/rake/shell_task'
+
+require 'fedux_org_stdlib/require_files'
+require_installed_gem('travis-lint')
+
+FeduxOrgStdlib::Rake::ShellTask.new(
+  name: 'qa:travis',
+  description: 'Runs travis-lint to check .travis.yml',
+  use_bundler: true,
+  command: 'travis-lint',
+  define_in_ci_mode: false,
+)

data/lib/fedux_org_stdlib/rake_tasks/terminal.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/rake/shell_task'
+
+FeduxOrgStdlib::Rake::ShellTask.new(
+  name: 'terminal',
+  description: 'Start a terminal multiplexer like tmux',
+  use_bundler: true,
+  command: 'script/terminal'
+)

data/lib/fedux_org_stdlib/rake_tasks/tests.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/rake_tasks/tests/cucumber'
+require 'fedux_org_stdlib/rake_tasks/tests/rspec'
+require 'fedux_org_stdlib/rake_tasks/tests/travis'

data/lib/fedux_org_stdlib/rake_tasks/tests/cucumber.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/rake/shell_task'
+
+require 'fedux_org_stdlib/require_files'
+require_installed_gem('cucumber')
+
+FeduxOrgStdlib::Rake::ShellTask.new(
+  name: 'test:cucumber',
+  description: 'Run cucumber',
+  use_bundler: true,
+  command: 'cucumber -p all'
+)
+

data/lib/fedux_org_stdlib/rake_tasks/tests/rspec.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/rake/shell_task'
+
+require 'fedux_org_stdlib/require_files'
+require_installed_gem('rspec')
+
+FeduxOrgStdlib::Rake::ShellTask.new(
+  name: 'test:rspec',
+  description: 'Run rspec',
+  use_bundler: true,
+  command: 'rspec'
+)

data/lib/fedux_org_stdlib/rake_tasks/tests/travis.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/rake/sub_task'
+require 'fedux_org_stdlib/rake_tasks/test/rspec'
+require 'fedux_org_stdlib/rake_tasks/test/cucumber'
+
+FeduxOrgStdlib::Rake::SubTask.new(
+  name: 'test:travis',
+  description: 'Runs rspec and cucumber on travis',
+  sub_tasks: %w{ test:rspec test:cucumber },
+  activate_ci_mode: true
+)

data/lib/fedux_org_stdlib/rake_tasks/version.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+require 'fedux_org_stdlib/rake_tasks/version/show_shortcut'
+require 'fedux_org_stdlib/rake_tasks/version/bump'
+require 'fedux_org_stdlib/rake_tasks/version/show'
+require 'fedux_org_stdlib/rake_tasks/version/restore'

data/lib/fedux_org_stdlib/rake_tasks/version/bump.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+require 'fedux_org_stdlib/rake/version_bump_task'
+
+FeduxOrgStdlib::Rake::VersionBumpTask.new(name: 'version:bump:major', description: 'Bump major version part') { |t| t.bump_version :major }
+FeduxOrgStdlib::Rake::VersionBumpTask.new(name: 'version:bump:minor', description: 'Bump minor version part') { |t| t.bump_version :minor }
+FeduxOrgStdlib::Rake::VersionBumpTask.new(name: 'version:bump:tiny',  description: 'Bump tiny version part')   { |t| t.bump_version :tiny }
+FeduxOrgStdlib::Rake::VersionBumpTask.new(name: 'version:bump',       description: 'Bump version to ENV["VERSION"] or ENV["version"]') { |t| t.set_version ENV['VERSION'] || ENV['version'] }

data/lib/fedux_org_stdlib/rake_tasks/version/restore.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require 'fedux_org_stdlib/versionable'
+require 'fedux_org_stdlib/rake/shell_task'
+
+task = FeduxOrgStdlib::Rake::ShellTask.new(
+  name: 'version:restore',
+  description: 'Restore version file from repository',
+  command: "git checkout <%= version_file %>"
+)
+task.include FeduxOrgStdlib::Versionable

data/lib/fedux_org_stdlib/rake_tasks/version/show.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/versionable'
+require 'fedux_org_stdlib/rake/task'
+
+task = FeduxOrgStdlib::Rake::Task.new(
+  name: 'version:show',
+  description: 'Show version'
+) do |t|
+  $stderr.puts FeduxOrgStdlib::VersionManagement::RubygemVersionFile.read(version_file).version 
+end
+task.include FeduxOrgStdlib::Versionable
+