pointrb 0.0.1 → 0.1.0

data/features/support/helper.rb

@@ -0,0 +1,62 @@
+#encoding: utf-8
+require 'bob_the_helper'
+
+
+include BobTheHelper::FileSystem
+include BobTheHelper::Command
+
+def root_directory
+  File.expand_path('../../../', __FILE__)
+end
+
+def pointrb_config_directories
+  result = []
+  result << expand_path( File.join('~', '.config', 'pointrb' ) )
+  result << expand_path( File.join('~', '.config', 'pointrb', 'layouts' ) )
+
+  result
+end
+
+def run_this_command(command)
+  search_paths = [ File.join( root_directory, 'bin' ) , '/usr/bin', '/bin' ]
+
+  new_env_vars = { 
+    'HOME' => File.join(working_directory, ENV['HOME']),
+    'PATH' => search_paths.join(':') 
+  }
+
+  if @cmd_debug
+    runner = lambda do |cmd| 
+      r = system(cmd) 
+
+      status_klass = Class.new do
+        def initialize(status)
+          @status = status
+        end
+
+        def success?
+          @status
+        end
+      end
+
+      result = CommandResult.new
+      result.stderr = "Keep in mind, you're in debugging mode. Look for '@cmd_debug' in your feature files"
+      result.stdout = "Keep in mind, you're in debugging mode. Look for '@cmd_debug' in your feature files"
+      result.status = status_klass.new(r)
+
+      result
+    end
+  else
+    runner = lambda { |cmd| run_command(cmd) }
+  end
+
+  result = isolated_environment new_env_vars  do
+
+    cmd_result = switch_to_working_directory do
+      runner.call(command)
+    end
+
+    cmd_result
+  end
+
+end

data/gemfiles/Gemfile.default

@@ -22,9 +22,10 @@ group :development do
   gem 'debugger'
   gem 'pry'
   gem 'pry-doc'
+  gem 'pry-debugger'
+  gem 'debugger-completion'
   gem 'awesome_print'
   gem 'travis-lint'
-  gem 'activesupport'
   gem 'fuubar'
   gem 'churn'
 end

data/lib/bob_the_helper/command/command_result.rb

@@ -0,0 +1,12 @@
+module BobTheHelper
+  module Command
+    class CommandResult
+      attr_accessor :stderr, :stdout, :status
+
+      def initialize
+        @stderr = ''
+        @stdout = ''
+      end
+    end
+  end
+end

data/lib/bob_the_helper/command.rb

@@ -0,0 +1,49 @@
+require 'open3'
+
+require 'bob_the_helper/environment'
+require 'bob_the_helper/command/command_result'
+
+module BobTheHelper
+  module Command
+    include Environment
+
+    # Execute command
+    #
+    # @param [String] cmd
+    #   the command 
+    #
+    # @param [Hash] options
+    #   the options for command execution
+    #
+    # @option options [Hash] env ({])
+    #   the environment variables for the command ('VAR' => 'CONTENT')
+    #
+    # @option options [String] stdin (nil)
+    #   the string for stdin of the command
+    #
+    # @option options [TrueClass,FalseClass] binmode (false)
+    #   should the stdin be read a binary or not
+    #
+    # @return [CommandResult]
+    #   the result of the command execution
+    #
+    # @return [CommandResult]
+    #   the result of the command execution
+    def run_command(cmd,options={})
+      opts = {
+        env: nil,
+        stdin: nil,
+        binmode: false,
+      }.merge options
+
+      env = opts[:env] || ENV.to_hash
+      stdin = opts[:stdin] 
+      binmode = opts[:binmode]
+
+      result = CommandResult.new
+      result.stdout, result.stderr, result.status = Open3.capture3(env, cmd, stdin_data: stdin, chdir: working_directory, binmode: binmode)
+
+      result
+    end
+  end
+end

data/lib/bob_the_helper/environment.rb

@@ -0,0 +1,27 @@
+module BobTheHelper
+  module Environment
+
+    # Set environment variable for code block
+    #
+    # @param [Hash] variables
+    #   the variables which should be set for that environment
+    #
+    # @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
+
+      block_result = block.call
+
+      #cleanup
+      ENV.clear 
+      #install backuped information
+      ENV.update old_env
+
+      block_result
+    end
+  end
+end

data/lib/bob_the_helper/file_system/exceptions.rb

@@ -0,0 +1,11 @@
+module BobTheHelper
+  module FileSystem
+    module Exceptions
+      # Raise if path with '..' given
+      class InvalidPath < Exception; end
+
+      #Raised if library is not used correctly
+      class InvalidUsageOfLibrary < Exception; end
+    end
+  end
+end

data/lib/bob_the_helper/file_system.rb

@@ -0,0 +1,245 @@
+require 'fileutils'
+require 'bob_the_helper/file_system/exceptions'
+
+# helper for file system
+module BobTheHelper
+  module FileSystem
+
+    # The root directory of the project
+    #
+    # @return [String]
+    #   the root directory
+    def root_directory
+      #File.expand_path('../../../', __FILE__)
+      raise Exceptions::InvalidUsageOfLibrary , "Sorry, but you need to define the root directory yourself"
+    end
+
+    # The temporary directory for the project
+    #
+    # @return [String]
+    #   the directory created for the tests 
+    def working_directory
+      File.join(root_directory, 'tmp', 'test')
+    end
+
+    # Create temporary directory
+    def create_working_directory
+      FileUtils.mkdir_p(working_directory) unless File.exists? working_directory
+    end
+
+    # Delete temporary directory
+    def delete_working_directory
+      FileUtils.rm_rf(working_directory) if File.exists? working_directory
+    end
+
+    # Clean up test directory
+    def cleanup_working_directory
+      delete_working_directory
+      create_working_directory
+    end
+
+    # Switch the current working directory to 
+    # the temporary one and execute code block
+    def switch_to_working_directory(&block)
+      Dir.chdir(working_directory, &block)
+    end
+
+    # Create directory(ies)
+    #
+    # @param [String,Array] dir
+    #   the directories to be created, multiple arguments are possible as well
+    #
+    # @return [String,Array] 
+    #   returns a string if there was only one file given, and an array with 
+    #   muliple files
+    def create_directory(*dirs)
+      raise_if_forbidden_path_for_delete_operation(dirs)
+
+      directories = expand_path(dirs.flatten)
+      FileUtils.mkdir_p(directories)
+
+      if directories.size == 1
+        return directories.first
+      else
+        return directories
+      end
+    end
+
+    # Delete directory(ies)
+    #
+    # @param [String, Array] dir
+    #   the directories to be deleted, multiple arguments are possible as well
+    #
+    # @return [String,Array] 
+    #   returns a string if there was only one file given, and an array with 
+    #   muliple files
+    def delete_directory(*dirs)
+      raise_if_forbidden_path_for_delete_operation(dirs)
+
+      directories = expand_path(dirs.flatten)
+      FileUtils.rm_r(directories)
+
+      if directories.size == 1
+        return directories.first
+      else
+        return directories
+      end
+    end
+
+    # Check existence of path(s)
+    #
+    # @param [String,Array] paths
+    #   which path(s) should be checked, multiple arguments are possible as well
+    #
+    # @return [TrueClass,FalseClass]
+    #   the result of all checks done
+    def path_exists?(*paths)
+      raise_if_forbidden_path_for_create_operation(paths)
+
+      paths_expanded = expand_path(paths.flatten)
+      paths_expanded.flatten.all? { |p| File.exists?(p) }
+    end
+
+    # Check absence of path(s)
+    #
+    # @param [String,Array] paths
+    #   which path(s) should be checked, multiple arguments are possible as well
+    #
+    # @return [TrueClass,FalseClass]
+    #   the result of all checks done
+    def path_does_not_exist?(*paths)
+      not path_exists?(paths)
+    end
+
+    # Create a single file
+    #
+    # @param [String] file_path
+    #   the path for the new file (can include directories)
+    #
+    # @param [String] content
+    #   the content written to the file
+    #
+    # @return [String]
+    #   the path to the created file
+    def create_file(path, content='')
+      raise_if_forbidden_path_for_create_operation(path)
+
+      file = expand_path(path).first
+      directory = File.dirname(file)
+
+      FileUtils.mkdir_p(directory) unless directory == '.'
+      File.open(file, "wb") do |f|
+        f.write content
+      end
+
+      file
+    end
+
+    # Delete a single file
+    #
+    # @param [String] file_path
+    #   the path for the new file (can include directories)
+    #
+    # @param [String] content
+    #   the content written to the file
+    #
+    # @return [String]
+    #   the path to the created file
+    def delete_file(*files)
+      raise_if_forbidden_path_for_delete_operation(files)
+
+      files_to_be_deleted = expand_path(files.flatten)
+      FileUtils.rm(files_to_be_deleted)
+
+      if files_to_be_deleted.size == 1
+        return files_to_be_deleted.first
+      else
+        return files_to_be_deleted
+      end
+    end
+
+    # Read the content of a file
+    #
+    # @param [String] file_path
+    #   the path to the file
+    #
+    # @return [String,Binary] 
+    #   the content of the file
+    def read_file(path)
+      raise_if_forbidden_path_for_create_operation(path)
+
+      file_path = expand_path(path).first
+      return File.read(file_path)
+    end
+
+    # Expand path based on temporary directory
+    #
+    # @param [String, Array, Multiple Values] paths
+    #   the paths to be expanded
+    #
+    # @return [Array, String]
+    #   the expanded arrays
+    def expand_path(*paths)
+      raise_if_forbidden_path_for_create_operation(paths)
+
+      paths.flatten.map do |p| 
+        case p 
+        when /^~/
+          File.expand_path(p) 
+        else
+          File.join(working_directory, p ) 
+        end
+      end
+    end
+
+    # Check if path is forbidden for delete operation
+    # 
+    # @param [String, Array] paths
+    #   paths which should be checked
+    #
+    # @return [TrueClass, FalseClass]
+    #   true if path is forbidden, false if path is not forbidden
+    def raise_if_forbidden_path_for_create_operation(*paths)
+      flattend_paths = paths.flatten
+      strings = []
+      regex = %r[\.\.]
+
+      raise FileSystem::Exceptions::InvalidPath , "Sorry, but you cannot use paths matching \"#{strings.join(', ')}\"  or \"#{regex.to_s}\" here!" if path_matches?(strings, regex, flattend_paths)
+    end
+
+    # Check if path is forbidden for delete operation
+    #
+    # @param [String, Array] paths
+    #   paths which should be checked
+    #
+    # @return [TrueClass, FalseClass]
+    #   true if path is forbidden, false if path is not forbidden
+    def raise_if_forbidden_path_for_delete_operation(*paths)
+      flattend_paths = paths.flatten
+      strings = %w[ / ]
+      regex = %r[\.\.]
+
+      raise FileSystem::Exceptions::InvalidPath , "Sorry, but you cannot use paths matching \"#{strings.join(', ')}\"  or \"#{regex.to_s}\" here!" if path_matches?(strings, regex, flattend_paths)
+    end
+
+    # Check if path matches
+    #
+    # @param [Array, String] strings
+    #   strings which are checked against paths
+    #
+    # @param [Array, String] regex
+    #   regex which is checked against path
+    #
+    # @param [Array, String] paths
+    #   the paths to be checked
+    #
+    # @result [TrueClass, FalseClass] 
+    #   true if path is valid, false if invalid
+    def path_matches?(strings, regex, *paths)
+      flattend_paths = paths.flatten
+      flattend_strings = strings.flatten
+
+      flattend_paths.any? { |f|  f =~ regex or flattend_strings.include?(f) }
+    end
+  end
+end

data/lib/bob_the_helper.rb

@@ -0,0 +1,5 @@
+require 'bob_the_helper/environment'
+require 'bob_the_helper/file_system'
+require 'bob_the_helper/command'
+
+module BobTheHelper; end

data/lib/pointrb/actions/check_if_pointrb_has_already_been_initialized.rb

@@ -0,0 +1,15 @@
+module PointRb
+  module Actions
+    class CheckIfPointRbHasAlreadyBeenInitialized
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        raise Exceptions::PointRbWasAlreadInitialized , "This system has already been setup." if File.exists? env.layout_directory
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/pointrb/actions/check_project_path.rb

@@ -0,0 +1,15 @@
+module PointRb
+  module Actions
+    class CheckProjectPath
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        raise PointRb::Exceptions::ProjectPathExists, "Directory '#{env.project.name}' exists." if File.exists? env.project.path
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/pointrb/actions/create_layout.rb

@@ -0,0 +1,16 @@
+module PointRb
+  module Actions
+    class CreateLayout
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        env.layout.create
+        puts "[Information] Layout '#{env.layout.name}' for project '#{env.project.name}' created."
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/pointrb/actions/create_project_wrapper.rb

@@ -0,0 +1,15 @@
+module PointRb
+  module Actions
+    class CreateProjectWrapper
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        env.project = PointRb::Project.new(env.project_name)
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/pointrb/actions/determine_layout_directory.rb

@@ -0,0 +1,14 @@
+module PointRb
+  module Actions
+    class DetermineLayoutDirectory
+      def initialize(app)
+        @app   = app
+      end
+
+      def call(env)
+        env.layout_directory = File.join(ENV['HOME'], '.config', 'pointrb', 'layouts')
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/pointrb/actions/error_handler_commandline.rb

@@ -0,0 +1,39 @@
+module PointRb
+  module Actions
+    class ErrorHandlerCommandline
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        begin
+          @app.call(env)
+        rescue Exceptions::SyntaxErrorInLayout => e
+          error_msg e.message, 1
+        rescue Exceptions::ProjectPathExists => e
+          error_msg e.message, 2
+        rescue Exceptions::PointRbWasAlreadInitialized => e
+          error_msg e.message, 3
+        rescue Exceptions::LayoutNotFound => e
+          error_msg e.message, 4
+        rescue Exception => e
+
+          if env.command_line_options[:verbose]
+            message = e.message
+          else
+            message = 'An unknown error occured. If you would like to see a more verbose output, then please use the --verbose option.'
+          end
+
+          error_msg message, -1
+        end
+      end
+
+      private
+
+      def error_msg(msg, return_code)
+        $stderr.puts "[Error] #{msg} Exit!"
+        exit return_code
+      end
+    end
+  end
+end

data/lib/pointrb/actions/initialize_pointrb.rb

@@ -0,0 +1,15 @@
+module PointRb
+  module Actions
+    class InitializePointRb
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        FileUtils.mkdir_p env.layout_directory
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/pointrb/actions/retrieve_layout_files.rb

@@ -0,0 +1,16 @@
+module PointRb
+  module Actions
+    class RetrieveLayoutFiles
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        layout_storage_manager = PointRb::LayoutStorageManager.new(env.layout_directory)
+        env.layout_files = layout_storage_manager.retrieve_all
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/pointrb/actions/retrieve_parsed_layout.rb

@@ -0,0 +1,17 @@
+module PointRb
+  module Actions
+    class RetrieveParsedLayout 
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        layout_manager = PointRb::LayoutManager.new(env.layout_files, env.project)
+        layout_name = env.command_line_options[:layout].to_sym
+
+        env.layout = layout_manager.retrieve(layout_name)
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/pointrb/actions/set_project_name.rb

@@ -0,0 +1,15 @@
+module PointRb
+  module Actions
+    class CreateProjectWrapper
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        env.project = PointRb::Project.new(env.project_name)
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/pointrb/actions/show_pointrb_version.rb

@@ -0,0 +1,14 @@
+module PointRb
+  module Actions
+    class ShowPointRbVersion
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+  puts "Version: #{PointRb::VERSION}"
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/pointrb/api.rb

@@ -0,0 +1,36 @@
+module PointRb
+  class Api
+    def self.create_layout(env)
+      stack = Middleware::Builder.new do
+        use Actions::ErrorHandlerCommandline
+        use Actions::CreateProjectWrapper
+        use Actions::CheckProjectPath
+        use Actions::DetermineLayoutDirectory
+        use Actions::RetrieveLayoutFiles
+        use Actions::RetrieveParsedLayout
+        use Actions::CreateLayout
+      end
+
+      stack.call(env)
+    end
+
+    def self.initialize_pointrb(env)
+      stack = Middleware::Builder.new do
+        use Actions::ErrorHandlerCommandline
+        use Actions::DetermineLayoutDirectory
+        use Actions::CheckIfPointRbHasAlreadyBeenInitialized
+        use Actions::InitializePointRb
+      end
+
+      stack.call(env)
+    end
+
+    def self.show_version
+      stack = Middleware::Builder.new do
+        use Actions::ShowPointRbVersion
+      end
+
+      stack.call
+    end
+  end
+end