fedux_org-stdlib 0.3.2 → 0.6.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a658594f0dd9d467af925caa9620758e617922db
+  data.tar.gz: 203f8edd0ecaaab10cf209bd742ab00053116a6d
+SHA512:
+  metadata.gz: ab79328e1e94f5dcf316262af0a0ea7d70262dfd95f4a3c3dc8f064343c2cc51ca7e76350291d5c390c94f61aa7e558b0d76ead92408e8d9b92d26ea59242c35
+  data.tar.gz: 6d545af99e51fe167f3da93031f4fbf079eb0da2d90293a26ea004d4f89cb68f22eac06e525392dfa7b333318b9e556ddeda8a22f00e637dd5ef6362b7852911

data/.rspec

@@ -1,2 +1,4 @@
+--require rspec/legacy_formatters
 --format Fuubar
 --order rand
+--color

data/.simplecov

@@ -1,10 +1,11 @@
+# encoding: utf-8
 SimpleCov.start do
   add_filter "/features/"
   add_filter "/spec/"
-  add_group "stdlib", "lib/fedux_org/stdlib"
-  add_group "models", "lib/fedux_org/stdlib/models"
-  add_group "logging", "lib/fedux_org/stdlib/logging"
-  add_group "command", "lib/fedux_org/stdlib/command"
-  add_group "environment", "lib/fedux_org/stdlib/environment"
-  add_group "filesystem", "lib/fedux_org/stdlib/filesystem"
+  add_group "stdlib", "lib/fedux_org_stdlib"
+  add_group "models", "lib/fedux_org_stdlib/models"
+  add_group "logging", "lib/fedux_org_stdlib/logging"
+  add_group "command", "lib/fedux_org_stdlib/command"
+  add_group "environment", "lib/fedux_org_stdlib/environment"
+  add_group "filesystem", "lib/fedux_org_stdlib/filesystem"
 end

data/Gemfile

@@ -1,37 +1,42 @@
 source 'https://rubygems.org'
 
-gemspec 
+# use gem spec 
+gemspec
 
-gem 'launchy'
-gem 'command_exec'
-gem 'taskjuggler'
-gem 'versionomy'
+group :development, :test do
+  gem 'pry', require: false
+  gem 'pry-doc', require: false
 
-group :test do
-  gem 'rake'
-  gem 'rspec'
-  gem 'simplecov'
-  gem 'aruba'
-  gem 'fuubar'
-  gem 'ffaker'
-end
+  if RUBY_VERSION < '2.0.0'
+    gem 'pry-debugger', require: false
+    gem 'debugger'
+    gem 'debugger-completion', require: false
+  else
+    gem 'pry-byebug', require: false
+    gem 'byebug'
+  end
 
-group :documentation do
-  gem 'yard'
-  gem 'redcarpet'
+  gem 'aruba', require: false
+  gem 'awesome_print', require: 'ap'
+  gem 'bundler', '>= 1.3', require: false
+  gem 'coveralls', require: false
+  gem 'cucumber', require: false
+  gem 'erubis'
+  gem 'fuubar'
   gem 'github-markup'
-end
+  gem 'rake', require: false
+  gem 'redcarpet'
+  gem 'rspec', require: false
+  gem 'rspec-legacy_formatters', require: false
+  gem 'rubocop', require: false
+  gem 'simplecov'
+  gem 'tmrb', require: false
+  gem 'versionomy'
+  gem 'filegen'
 
-group :development do
-  gem 'tmrb'
-  gem 'erubis'
-  gem 'debugger'
-  gem 'pry'
-  gem 'pry-doc'
-  gem 'pry-debugger'
-  gem 'debugger-completion'
-  gem 'awesome_print'
+  gem 'command_exec'
+  gem 'taskjuggler'
+  gem 'launchy'
+  gem 'yard'
   gem 'travis-lint'
-  gem 'fuubar'
-  gem 'churn'
 end

data/README.md

@@ -1,4 +1,4 @@
-# FeduxOrg::Stdlib
+# FeduxOrgStdlib
 
 Gem with a lot of stuff which can be used in other libraries.
 

data/Rakefile

@@ -1,3 +1,10 @@
 #!/usr/bin/env rake
 
-require 'fedux_org/stdlib/rake'
+$LOAD_PATH << File.expand_path('../lib', __FILE__)
+
+require 'fedux_org_stdlib/rake_tasks'
+
+desc 'Show help for rake'
+task :default do
+  sh 'bundle exec rake -T'
+end

data/doc/colors.md

@@ -1,11 +1,11 @@
-# FeduxOrg::Stdlib::HtmlColor
+# FeduxOrgStdlib::HtmlColor
 
 ## Usage
 
 ### HtmlColor
 
 ```ruby
-require 'fedux_org/stdlib/colors/html_color'
+require 'fedux_org_stdlib/colors/html_color'
 ```
 
 ```ruby

data/doc/commands.md

@@ -1,4 +1,4 @@
-# FeduxOrg::Stdlib::Command
+# FeduxOrgStdlib::Command
 
 ## Usage
 
@@ -7,7 +7,7 @@
 Searches command in PATH. It supports the usage of a full path as well.
 
 ```ruby
-require 'fedux_org/stdlib/command'
+require 'fedux_org_stdlib/command'
 
 class XY
   include Command

data/doc/logic_converters.md

@@ -1,27 +1,27 @@
-# FeduxOrg::Stdlib::LogicConverters
+# FeduxOrgStdlib::LogicConverters
 
 ## Usage
 
 ### LogicConverter
 
 ```ruby
-require 'fedux_org/stdlib/logic_converters/logic_converter'
+require 'fedux_org_stdlib/logic_converters/logic_converter'
 ```
 
 ### YesNoConverter
 
 ```ruby
-require 'fedux_org/stdlib/logic_converters/yes_no_converter'
+require 'fedux_org_stdlib/logic_converters/yes_no_converter'
 ```
 
 ### TrueFalseConverter
 
 ```ruby
-require 'fedux_org/stdlib/logic_converters/true_false_converter'
+require 'fedux_org_stdlib/logic_converters/true_false_converter'
 ```
 
 ### OnOffConverter
 
 ```ruby
-require 'fedux_org/stdlib/logic_converters/on_off_converter'
+require 'fedux_org_stdlib/logic_converters/on_off_converter'
 ```

data/doc/models.md

@@ -1,4 +1,4 @@
-# FeduxOrg::Stdlib::Models
+# FeduxOrgStdlib::Models
 
 ## Usage
 
@@ -7,23 +7,23 @@
 This file requires all other files found below.
 
 ```ruby
-require 'fedux_org/stdlib/models'
+require 'fedux_org_stdlib/models'
 ```
 
 ### BaseModel
 
 ```ruby
-require 'fedux_org/stdlib/models/base_model'
+require 'fedux_org_stdlib/models/base_model'
 ```
 
 ### ClassBaseModel
 
 ```ruby
-require 'fedux_org/stdlib/models/class_based_model'
+require 'fedux_org_stdlib/models/class_based_model'
 ```
 
 ### FileSystemBasedModel
 
 ```ruby
-require 'fedux_org/stdlib/models/filesystem_based_model'
+require 'fedux_org_stdlib/models/filesystem_based_model'
 ```

data/fedux_org-stdlib.gemspec

@@ -1,15 +1,14 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'fedux_org/stdlib/version'
+require 'fedux_org_stdlib/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "fedux_org-stdlib"
-  spec.version       = FeduxOrg::Stdlib::VERSION
+  spec.version       = FeduxOrgStdlib::VERSION
   spec.authors       = ["Max Meyer"]
   spec.email         = ["dev@fedux.org"]
-  spec.description   = %q{collection of useful libraries}
-  spec.summary       = %q{collection of useful libraries}
+  spec.summary       = %q{Collection of useful libraries. It maybe depend on external libraries.}
   spec.homepage      = ""
   spec.license       = "MIT"
 
@@ -18,8 +17,5 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake'
-
   spec.add_dependency 'activesupport'
 end

data/lib/fedux_org_stdlib.rb

@@ -0,0 +1,13 @@
+require 'fedux_org_stdlib/command'
+require 'fedux_org_stdlib/environment'
+require 'fedux_org_stdlib/filesystem'
+require 'fedux_org_stdlib/logging'
+require 'fedux_org_stdlib/logic_converters'
+require 'fedux_org_stdlib/models'
+require 'fedux_org_stdlib/version'
+
+module FeduxOrgStdlib
+  def self.root_directory
+    File.expand_path( '../../..', __FILE__ )
+  end
+end

data/lib/fedux_org_stdlib/app_config.rb

@@ -0,0 +1,247 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/require_files'
+require_library %w{ json psych active_support/core_ext/string/inflections }
+
+module FeduxOrgStdlib
+  module Exceptions
+    # One wants to modify a locked config
+    class ConfigLocked < StandardError; end
+
+    # Found config file is not readable
+    class ConfigFileNotReadable < StandardError; end
+
+    # No allowed config file could be found
+    class NoConfigFileFound < StandardError; end
+  end
+
+  # This class makes a config file available as an object. The config file
+  # needs to be `YAML` by default. It is read by `Psych` and converted to a
+  # hash. If you chose to use a different file format: Each config file needs
+  # to translatable to a hash or another data structure which responds to
+  # `[]` by the given `config_engine`.
+  #
+  # By default it will look for a suitable config file in the given order:
+  #
+  # 1. $HOME/.config/<application_name>/<config_file>
+  # 2. $HOME/.<application_name>/<config_file>
+  # 3. /etc/.<application_name>/<config_file>
+  #
+  # Most conventions are implemented by separate methods. If one conventions
+  # is not suitable for your use case, just overwrite the method. 
+  #
+  # If you prefer to use a different path to the config file or name of the
+  # config file one of the following methods needs to be overwritten:
+  #
+  # * config_file
+  # * config_name
+  # * application_name
+  #
+  # If you want the class to look for your config file at a different place
+  # overwrite the following method
+  #
+  # * allowed_config_file_paths
+  #
+  # Below you find some examples for the usage of the class:
+  #
+  # @example Create config
+  #
+  # class MyConfig < AppConfig
+  #   # This is the default if no config file exists
+  #   option :option1, 'data1'
+  # end
+  #
+  # @example Config file
+  #
+  # option1: 'data2'
+  class AppConfig
+
+    # Set all neccessary class instance variables
+    def self.inherited(base)
+      base.instance_variable_set :@options, Set.new
+      base.instance_variable_set :@process_environment, ProcessEnvironment.new
+    end
+
+    class << self
+      # @!attribute [r] options
+      #   Read access to defined options
+      #
+      # @!attribute [r] process_environment
+      #   Read access to environment of process using this config
+      attr_reader :options, :process_environment
+
+      # Define a reader for option
+      #
+      # @param [Symbol] option
+      #   Name of option
+      #
+      # @param [Object] default_value
+      #   The default value of this option
+      def option_reader(option, default_value)
+        define_method option.to_sym do
+          config.fetch(option.to_sym, default_value)
+        end
+
+        @options << option
+      end
+
+      # Define a writer for option
+      #
+      # @param [Symbol] option
+      #   Name of option
+      #
+      # @raise [Exceptions::ConfigLocked]
+      #   If one tries to modified a locked config
+      def option_writer(option)
+        define_method "#{option}=".to_sym do |value|
+          begin
+            config[option.to_sym] = value
+          rescue RuntimeError
+            raise Exceptions::ConfigLocked
+          end
+        end
+
+        @options << option
+      end
+
+      # Define a writer and a reader for option
+      #
+      # @param [Symbol] option
+      #   Name of option
+      #
+      # @param [Object] default_value
+      #   Default value of option
+      def option(option, default_value)
+        option_reader(option, default_value)
+        option_writer(option)
+      end
+    end
+
+    private
+
+    attr_reader :config
+
+    public
+
+    # Create a new instance of config
+    #
+    # @param [String] file
+    #   Path where config file is stored. The file will be read by the
+    #   `config_engine`.
+    #
+    # @param [Object] config_engine (Psych)
+    #   The engine to read config file
+    #
+    # @raise [Exceptions::NoConfigFileFound]
+    #   If the config file could not be found
+    #
+    # @raise [Exceptions::ConfigFileNotReadable]
+    #   If an avaiable config file could not be read by the config engine
+    #
+    # @return [AppConfig]
+    #   The config instance. If the resulting data structure created by the
+    #   config_engine does not respond to `:[]` an empty config object will be
+    #   created. 
+    def initialize(file = available_config_file, config_engine = Psych)
+      fail Exceptions::NoConfigFileFound, JSON.dump(files: allowed_config_file_paths) unless file
+
+      config_mutex = Mutex.new
+
+      yaml = config_mutex.synchronize do
+        begin
+          Psych.load_file(file)
+        rescue StandardError => e
+          fail Exceptions::ConfigFileNotReadable, JSON.dump(message: e.message, file: file)
+        end
+      end
+
+      if yaml.respond_to? :[]
+        @config = yaml.symbolize_keys
+      else
+        @config = {}
+      end
+    end
+
+    # Lock the configuration
+    def lock
+      config.freeze
+    end
+
+    # Output a string presentation of the configuration
+    #
+    # @return [String]
+    #   An formatted version of the configuration
+    def to_s
+      result = []
+      result << sprintf("%20s | %s", 'option', 'value')
+      result << sprintf("%s + %s", '-' * 20, '-' * 80)
+
+      Config.options.each do |o|
+        result << sprintf("%20s | %s", o, Array(public_send(o)).join(', '))
+      end
+
+      result.join("\n")
+    end
+
+    private
+
+    # The name of the config file
+    #
+    # @return [String]
+    #   The name of the config file. It defaults to `<config_name>.yaml`. If
+    #   you want to use a different file name you need to overwrite this
+    #   method.
+    def config_file
+      "#{config_name}.yaml"
+    end
+
+    # The base name of the config
+    #
+    # @return [String]
+    #   This one returns the base name of the config file (without the file
+    #   extension). It uses the class name of the config class
+    #
+    # @example Determine the base name of the config
+    #
+    #   class ClientConfig; end
+    #
+    # This will result in `client` as base name for the config file.
+    def config_name
+      self.class.name.demodulize.sub(/Config/, '').underscore.pluralize
+    end
+
+    # The name of your application
+    #
+    # @return [String]
+    #  This will strip of the class part of fully qualified class name and
+    #  converted it to a path.
+    #
+    # @example Determine application name
+    #
+    #   class MyApplication::MyConfig; end
+    #
+    # This will be converted to
+    #
+    #    my_application
+    def application_name
+      self.class.to_s.deconstantize.underscore
+    end
+
+    # The paths where to look for the config file
+    #
+    # @return [Array]
+    #   A list of paths where the config object should look for its config
+    #   file.
+    def allowed_config_file_paths
+      [
+        ::File.expand_path(::File.join(self.class.process_environment.fetch('HOME'), '.config', application_name, config_file)),
+        ::File.expand_path(::File.join(self.class.process_environment.fetch('HOME'), format('.%s', application_name), config_file)),
+        ::File.expand_path(::File.join('/etc', application_name, config_file)),
+        #          ::File.expand_path("../../../../files/#{config_file}", __FILE__),
+      ]
+    end
+
+    def available_config_file
+      allowed_config_file_paths.find { |f| ::File.exists? f }
+    end
+  end
+end