fedux_org-stdlib 0.3.2 → 0.6.3

data/lib/fedux_org/stdlib/logic_converters.rb

@@ -1,12 +0,0 @@
-require 'fedux_org/stdlib/logic_converters/exceptions'
-require 'fedux_org/stdlib/logic_converters/logic_converter'
-require 'fedux_org/stdlib/logic_converters/on_off_converter'
-require 'fedux_org/stdlib/logic_converters/true_false_converter'
-require 'fedux_org/stdlib/logic_converters/yes_no_converter'
-
-module FeduxOrg
-  module Stdlib
-    module LogicConverters
-    end
-  end
-end

data/lib/fedux_org/stdlib/logic_converters/logic_converter.rb

@@ -1,40 +0,0 @@
-require 'fedux_org/stdlib/logic_converters/exceptions'
-
-require 'fedux_org/stdlib/logic_converters/on_off_converter'
-require 'fedux_org/stdlib/logic_converters/true_false_converter'
-require 'fedux_org/stdlib/logic_converters/yes_no_converter'
-require 'fedux_org/stdlib/logic_converters/y_n_converter'
-
-module FeduxOrg
-  module Stdlib
-    module LogicConverters
-      class LogicConverter
-
-        # @param [String, Symbol] type (true_false, yes_no, on_off)
-        #   choose the type of converter which should be used 
-        def initialize(type)
-          @converter = case type.to_s
-                       when 'true_false'
-                         TrueFalseConverter.new
-                       when 'yes_no' 
-                         YesNoConverter.new
-                       when 'on_off' 
-                         OnOffConverter.new
-                       when 'y_n' 
-                         YNConverter.new
-                       else
-                         raise FeduxOrg::Stdlib::LogicConverters::Exceptions::InvalidType, "Unknown type \"#{type}\" for logic converter. Valid types are \"true_false\", \"yes_no\" or \"on_off\"."
-                       end
-        end
-
-        # @param [true,false] value
-        #   the logic value which should be converted
-        # @return [String]
-        #   the converted value
-        def parse( value )
-          @converter.parse( value )
-        end
-      end
-    end
-  end
-end

data/lib/fedux_org/stdlib/logic_converters/on_off_converter.rb

@@ -1,36 +0,0 @@
-require 'fedux_org/stdlib/logic_converters/exceptions'
-
-module FeduxOrg
-  module Stdlib
-    module LogicConverters
-      class OnOffConverter
-
-        # @param [true,false] value
-        #   the logic value which should be converted
-        # @return [String]
-        #   the converted value: true => on, false => off, '' => nil
-        #
-        # @example Parse true
-        #    converter = FeduxOrg::Stdlib::LogicConverters::OnOffConverter.new
-        #    converter.parse( true ) # on
-        #
-        # @example Parse false
-        #    converter = FeduxOrg::Stdlib::LogicConverters::OnOffConverter.new
-        #    converter.parse( false ) # off
-        #   
-        def parse( value )
-          case value
-          when true
-            'on'
-          when false
-            'off'
-          when ''
-            nil
-          else
-            raise FeduxOrg::Stdlib::LogicConverters::Exceptions::InvalidValue, "Unknown logic value \"#{value}\"."
-          end
-        end
-      end
-    end
-  end
-end

data/lib/fedux_org/stdlib/logic_converters/true_false_converter.rb

@@ -1,35 +0,0 @@
-require 'fedux_org/stdlib/logic_converters/exceptions'
-
-module FeduxOrg
-  module Stdlib
-    module LogicConverters
-      class TrueFalseConverter
-
-        # @param [true,false] value
-        #   the logic value which should be converted
-        # @return [String]
-        #   the converted value: true => 'true', false => 'false', '' => nil
-        #
-        # @example Parse true
-        #    converter = FeduxOrg::Stdlib::LogicConverters::OnOffConverter.new
-        #    converter.parse( true ) # 'true'
-        #
-        # @example Parse false
-        #    converter = FeduxOrg::Stdlib::LogicConverters::OnOffConverter.new
-        #    converter.parse( false ) # 'false'
-        def parse( value )
-          case value
-          when true
-            'true'
-          when false
-            'false'
-          when ''
-            nil
-          else
-            raise FeduxOrg::Stdlib::LogicConverters::Exceptions::InvalidValue, "Unknown logic value \"#{value}\"."
-          end
-        end
-      end
-    end
-  end
-end

data/lib/fedux_org/stdlib/logic_converters/y_n_converter.rb

@@ -1,35 +0,0 @@
-require 'fedux_org/stdlib/logic_converters/exceptions'
-
-module FeduxOrg
-  module Stdlib
-    module LogicConverters
-      class YNConverter
-
-        # @param [true,false] value
-        #   the logic value which should be converted
-        # @return [String]
-        #   the converted value: true => y, false => n, '' => nil
-        #
-        # @example Parse true
-        #    converter = FeduxOrg::Stdlib::LogicConverters::OnOffConverter.new
-        #    converter.parse( true ) # 'y'
-        #
-        # @example Parse false
-        #    converter = FeduxOrg::Stdlib::LogicConverters::OnOffConverter.new
-        #    converter.parse( false ) # 'n'
-        def parse( value )
-          case value
-          when true
-            'y'
-          when false
-            'n'
-          when ''
-            nil
-          else
-            raise FeduxOrg::Stdlib::LogicConverters::Exceptions::InvalidValue, "Unknown logic value \"#{value}\"."
-          end
-        end
-      end
-    end
-  end
-end

data/lib/fedux_org/stdlib/logic_converters/yes_no_converter.rb

@@ -1,35 +0,0 @@
-require 'fedux_org/stdlib/logic_converters/exceptions'
-
-module FeduxOrg
-  module Stdlib
-    module LogicConverters
-      class YesNoConverter
-        # @param [true,false] value
-        #   the logic value which should be converted
-        # @return [String]
-        #   the converted value: true => yes, false => no, '' => nil
-        #
-        # @example Parse true
-        #    converter = FeduxOrg::Stdlib::LogicConverters::OnOffConverter.new
-        #    converter.parse( true ) # 'yes'
-        #
-        # @example Parse false
-        #    converter = FeduxOrg::Stdlib::LogicConverters::OnOffConverter.new
-        #    converter.parse( false ) # 'no'
-        #   
-        def parse( value )
-          case value
-          when true
-            'yes'
-          when false
-            'no'
-          when ''
-            nil
-          else
-            raise FeduxOrg::Stdlib::LogicConverters::Exceptions::InvalidValue, "Unknown logic value \"#{value}\"."
-          end
-        end
-      end
-    end
-  end
-end

data/lib/fedux_org/stdlib/models.rb

@@ -1,4 +0,0 @@
-require 'fedux_org/stdlib/models/exceptions'
-require 'fedux_org/stdlib/models/base_model'
-require 'fedux_org/stdlib/models/class_based_model'
-require 'fedux_org/stdlib/models/filesystem_based_model'

data/lib/fedux_org/stdlib/models/base_model.rb

@@ -1,129 +0,0 @@
-require 'fedux_org/stdlib/logging'
-require 'fedux_org/stdlib/models/exceptions'
-
-module FeduxOrg
-  module Stdlib
-    module Models
-      class BaseModel
-
-        include Comparable
-
-        @instances = ::Set.new
-
-        attr_reader :name
-
-        def self.inherited(base)
-          base.instance_variable_set(:@instances, Set.new)
-        end
-
-        def initialize(name)
-          @name = name.to_sym
-          @enabled = false
-        end
-
-        #enable action
-        def enable
-          @enabled = true
-        end
-
-        #check if action is enabled
-        def enabled?(val=true)
-          @enabled == val
-        end
-
-        def name?(name)
-          @name == name
-        end
-
-        def <=>(other)
-          name <=> other.name
-        end
-
-        def eql?(other)
-          name == other.name
-        end
-
-        def hash
-          name.to_s.hash 
-        end
-
-        class << self
-          #attr_accessor :instances
-
-          def register(element)
-            @instances << element
-
-            element
-          end
-
-          def create( *args, &block )
-            if block_given?
-              register( new( *args, &block ) )
-            else
-              register( new( *args ) )
-            end
-          end
-
-          def delete( val )
-            element = self.find( val.to_s.to_sym )
-            raise FeduxOrg::Stdlib::Exceptions::InstanceNotFound unless element
-            @instances.delete element
-
-            element
-          end
-
-          def clear
-            @instances = Set.new
-          end
-
-          def all
-            @instances.to_a
-          end
-
-          #return all names as string
-          def all_names_as_string(connector=", ")
-            find_all(enabled: true).map(&:name).sort.join(connector)
-          end
-
-          def first
-            @instances.to_a.first
-          end
-
-          def last
-            @instances.to_a.last
-          end
-
-          #enables a specific instance
-          def enable(name)
-            find(name: name).enable
-          rescue NoMethodError => e
-            raise FeduxOrg::Stdlib::Models::Exceptions::InvalidSearchCriteria, "Sorry I'm not able to enable \"#{name}\". You need to create an instance with name \"#{name}\" first."
-          end
-
-          #finds a single instance
-          def find(criteria = {})
-            find_all(criteria).first
-          end
-
-          #finds all instances
-          def find_all(criteria = {})
-            FeduxOrg::Stdlib.logger.debug(self) { "Criteria for search: #{ criteria }" }
-            criteria = { name: criteria.to_sym } if criteria.kind_of? Symbol or criteria.kind_of? String
-
-            FeduxOrg::Stdlib.logger.debug(self) { "Instances to be searched for: #{ @instances.map { |i| "#{i.name} (#{i.class})" }.join(", ") }" }
-            @instances.find_all do |i| 
-              criteria.all? do |c,v|
-
-                FeduxOrg::Stdlib.logger.debug(self) { "Check method for search: #{ c }" }
-                i.send( "#{c}?".to_sym , v )
-              end
-            end
-          rescue NameError => e
-            raise FeduxOrg::Stdlib::Models::Exceptions::InvalidSearchCriteria, e.message
-          end
-        end
-
-      end
-    end
-  end
-end

data/lib/fedux_org/stdlib/models/class_based_model.rb

@@ -1,76 +0,0 @@
-begin
-  require 'active_support/core_ext/string/inflections'
-  require 'active_support/core_ext/object/blank'
-rescue LoadError
-  $stderr.puts 'You need to install the "activesupport"-gem to make that library work.'
-  exit 1 
-end
-
-require 'fedux_org/stdlib/models/filesystem_based_model'
-require 'find'
-
-module FeduxOrg
-  module Stdlib
-    module Models
-      # model for import action
-      module ClassBasedModel
-
-        def self.included(base)
-          base.extend ClassMethods
-        end
-
-        module ClassMethods
-
-          def require_path(name)
-            path = File.join( library_name.underscore , model_name.pluralize.underscore , name.to_s )
-            FeduxOrg::Stdlib.logger.debug(self) { "Path to instances of model \"#{name}\": #{path}" }
-
-            path
-          end
-
-          def exception_for_model
-            "#{library_name}::Exceptions::Invalid#{model_name}".constantize
-          rescue
-            raise FeduxOrg::Stdlib::Models::Exceptions::ExceptionNeedsToBeImplemented, "Exception \"#{library_name}::Exceptions::Invalid#{model_name}\" does not exist."
-          end
-
-          def check_klass( klass , *methods)
-            raise exception_for_model, "A valid \"#{model_name}\"-class needs to respond to \"#{ methods.flatten.join(", ") }\"." unless methods.flatten.all? { |m| klass.new.respond_to? m }
-          end
-
-          def build_class_constant(name)
-            "#{library_name}::#{model_name.pluralize}::#{name.to_s.camelcase}".constantize
-          rescue
-            raise exception_for_model , "Class \"#{library_name}::#{model_name.pluralize}::#{name.to_s.camelcase}\" cannot be found in file \"#{require_path(name)}\"."
-          end
-
-          def check_method
-            raise FeduxOrg::Stdlib::Models::Exceptions::MethodNeedsToBeImplemented, "Method \"check_method\" does not exist."
-          end
-
-          def suffix
-            '.rb'
-          end
-
-          def load_from_filesystem
-            files = find_files
-
-            FeduxOrg::Stdlib.logger.debug(self) { "Files found at path \"#{path_to_instances}\": #{ files.join(", ") }" }
-
-            raise FeduxOrg::Stdlib::Models::Exceptions::NoImplementationsForModelFound, "You might need to store files at \"#{File.dirname(path_to_instances)}\" to make the library work." if files.blank?
-
-            files.each do |f| 
-              instance_name = name( f )
-
-              require require_path( instance_name )
-
-              instance_klass = build_class_constant( instance_name )
-              check_klass( instance_klass, check_method )
-              create( instance_name , instance_klass.new )
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/fedux_org/stdlib/models/exceptions.rb

@@ -1,41 +0,0 @@
-module FeduxOrg
-  module Stdlib
-    module Models
-      module Exceptions
-        #internal error
-        class InternalError < Exception; end
-
-        #raised if one tries to delete an instance which
-        #does not exist
-        class InstanceNotFound < InternalError; end
-
-        #raised if one tries to use a keyword whose use
-        #is restricted
-        class UnauthorizedUseOfKeyword < InternalError; end
-
-        #raised if one uses invalid search criteria
-        class InvalidSearchCriteria < InternalError; end
-
-        #raised if the code which defines an import filter
-        #is malformed
-        class MethodNeedsToBeImplemented < InternalError; end
-
-        #raised if one tries to use an unimplemented exception
-        class ExceptionNeedsToBeImplemented < InternalError; end
-
-        #raised if one forgot to store files at `path_to_instances`
-        class NoImplementationsForModelFound < InternalError; end
-
-        #raised if an file system error occured
-        class FilesystemError < Exception ; end
-
-        #raise if a directory does not exist in filesystem
-        class DirectoryDoesNotExist < FilesystemError; end
-
-        #raise if a file does not exist in filesystem
-        class FileDoesNotExist < FilesystemError; end
-
-      end
-    end
-  end
-end