fedux_org-stdlib 0.0.22 → 0.0.23

data/.gitignore

@@ -7,7 +7,7 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
-doc/
+doc/yard/
 lib/bundler/man
 pkg
 rdoc

data/.yardopts

@@ -1,6 +1,9 @@
+--output ./doc/yard
 --verbose
 -
 API-GUIDE.md
 CONTRIBUTIONS.md
 LICENSE.md
 RELEASE_NOTES.md
+doc/logic_converters.md
+doc/models.md

data/README.md

@@ -1,6 +1,6 @@
 # FeduxOrg::Stdlib
 
-TODO: Write a gem description
+Gem with a lot of stuff which can be used in other libraries.
 
 ## Installation
 
@@ -16,9 +16,14 @@ Or install it yourself as:
 
     $ gem install fedux_org-stdlib
 
-## Usage
+## Further Reading
 
-You need to require the files... More is comming.
+* {file:models.md Models}
+* {file:logic_converters.md Logic Converters}
+* {file:logging.md Logging} #TBD
+* {file:filesystem.md Filesystem} #TBD
+* {file:rake.md Rake Tasks} #TBD
+* {file:environment.md Environment} #TBD
 
 ## Contributing
 

data/RELEASE_NOTES.md

@@ -0,0 +1,3 @@
+Version 0.0.23
+* + Add logic converters which can be used in puppet functions
+* + Documentation

data/doc/logic_converters.md

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

data/doc/models.md

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

data/lib/fedux_org/stdlib/command.rb

@@ -1,4 +1,5 @@
 require 'open3'
+require 'active_support/core_ext/string/inflections'
 
 require 'fedux_org/stdlib/environment'
 require 'fedux_org/stdlib/command/command_result'
@@ -46,6 +47,25 @@ module FeduxOrg
 
         result
       end
+    
+    # Search for command
+    # @param [String] cmd
+    #    name of command
+    #   
+    # @return [String] 
+    #   path to command
+    def which(cmd)
+      return nil if cmd.blank?
+    
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          exe = File.join(path, "#{cmd}#{ext}")
+          return exe if File.executable? exe
+        end
+      end                                                                                                                                                        
+      nil
     end
+
   end
 end

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

@@ -0,0 +1,12 @@
+module FeduxOrg
+  module Stdlib
+    module LogicConverters
+      module Exceptions
+        #raised if invalid value was provided for conversion 
+        class InvalidValue < Exception; end
+        #raised if invalid value was provided for conversion 
+        class InvalidType < Exception; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+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'
+
+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'
+                         YesNoConverter.new
+                       when 'yes_no' 
+                         TrueFalseConverter.new
+                       when 'on_off' 
+                         OnOffConverter.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

@@ -0,0 +1,27 @@
+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
+        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

@@ -0,0 +1,27 @@
+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
+        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/yes_no_converter.rb

@@ -0,0 +1,26 @@
+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
+        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/version.rb

@@ -1,6 +1,6 @@
 #main FeduxOrg
 module FeduxOrg
 module Stdlib
-  VERSION = '0.0.22'
+  VERSION = '0.0.23'
 end
 end

data/spec/logic_converters/on_off_converter_spec.rb

@@ -0,0 +1,17 @@
+require 'fedux_org/stdlib/logic_converters/on_off_converter'
+
+describe FeduxOrg::Stdlib::LogicConverters::OnOffConverter do
+  let( :converter ) { FeduxOrg::Stdlib::LogicConverters::OnOffConverter.new }
+
+  context '#parse' do
+    it 'converts true to on' do
+      result = converter.parse( true )
+      expect( result ).to eq( 'on' )
+    end
+
+    it 'converts false to off' do
+      result = converter.parse( false )
+      expect( result ).to eq( 'off' )
+    end
+  end
+end

data/spec/logic_converters/true_false_converter_spec.rb

@@ -0,0 +1,17 @@
+require 'fedux_org/stdlib/logic_converters/true_false_converter'
+
+describe FeduxOrg::Stdlib::LogicConverters::TrueFalseConverter do
+  let( :converter ) { FeduxOrg::Stdlib::LogicConverters::TrueFalseConverter.new }
+
+  context '#parse' do
+    it 'converts true to "true"' do
+      result = converter.parse( true )
+      expect( result ).to eq( 'true' )
+    end
+
+    it 'converts false to "false"' do
+      result = converter.parse( false )
+      expect( result ).to eq( 'false' )
+    end
+  end
+end

data/spec/logic_converters/yes_no_converter_spec.rb

@@ -0,0 +1,17 @@
+require 'fedux_org/stdlib/logic_converters/yes_no_converter'
+
+describe FeduxOrg::Stdlib::LogicConverters::YesNoConverter do
+  let( :converter ) { FeduxOrg::Stdlib::LogicConverters::YesNoConverter.new }
+
+  context '#parse' do
+    it 'converts true to "true"' do
+      result = converter.parse( true )
+      expect( result ).to eq( 'yes' )
+    end
+
+    it 'converts false to "false"' do
+      result = converter.parse( false )
+      expect( result ).to eq( 'no' )
+    end
+  end
+end

data/spec/models/class_based_model_spec.rb

@@ -244,7 +244,7 @@ describe Models::ClassBasedModel do
 
       expect {
         test_class.init
-      }.to_not raise_error TestIt::Exceptions::InvalidTestClass
+      }.not_to raise_error
     end
 
     it "supports multiple methods to check for invalid instance and fails if one is missing." do

data/spec/models/filesystem_based_model_spec.rb

@@ -128,8 +128,8 @@ describe Models::FilesystemBasedModel do
     it "search for available instances in filesystem" do
       expect( klass.send(:find_files) ).to eq(
         [
-          "/home/d/work/projects/fedux_org-stdlib/spec/examples/models/filesystem_based/find_files/abc.rb",
-          "/home/d/work/projects/fedux_org-stdlib/spec/examples/models/filesystem_based/find_files/cde.rb",
+          File.join( examples_dir, 'models', 'filesystem_based', 'find_files', 'abc.rb' ),
+          File.join( examples_dir, 'models', 'filesystem_based', 'find_files', 'cde.rb' )
         ]
       )
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fedux_org-stdlib
 version: !ruby/object:Gem::Version
-  version: 0.0.22
+  version: 0.0.23
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-31 00:00:00.000000000 Z
+date: 2013-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,7 +74,10 @@ files:
 - Gemfile
 - LICENSE.md
 - README.md
+- RELEASE_NOTES.md
 - Rakefile
+- doc/logic_converters.md
+- doc/models.md
 - fedux_org-stdlib.gemspec
 - lib/fedux_org/stdlib.rb
 - lib/fedux_org/stdlib/command.rb
@@ -84,6 +87,11 @@ files:
 - lib/fedux_org/stdlib/filesystem/exceptions.rb
 - lib/fedux_org/stdlib/logging.rb
 - lib/fedux_org/stdlib/logging/logger.rb
+- lib/fedux_org/stdlib/logic_converters/exceptions.rb
+- lib/fedux_org/stdlib/logic_converters/logic_converter.rb
+- lib/fedux_org/stdlib/logic_converters/on_off_converter.rb
+- lib/fedux_org/stdlib/logic_converters/true_false_converter.rb
+- lib/fedux_org/stdlib/logic_converters/yes_no_converter.rb
 - lib/fedux_org/stdlib/models.rb
 - lib/fedux_org/stdlib/models/base_model.rb
 - lib/fedux_org/stdlib/models/class_based_model.rb
@@ -125,6 +133,9 @@ files:
 - spec/examples/models/filesystem_based/find_files/abc.rb
 - spec/examples/models/filesystem_based/find_files/abc.rb.swp
 - spec/examples/models/filesystem_based/find_files/cde.rb
+- spec/logic_converters/on_off_converter_spec.rb
+- spec/logic_converters/true_false_converter_spec.rb
+- spec/logic_converters/yes_no_converter_spec.rb
 - spec/models/base_model_spec.rb
 - spec/models/class_based_model_spec.rb
 - spec/models/filesystem_based_model_spec.rb
@@ -166,6 +177,9 @@ test_files:
 - spec/examples/models/filesystem_based/find_files/abc.rb
 - spec/examples/models/filesystem_based/find_files/abc.rb.swp
 - spec/examples/models/filesystem_based/find_files/cde.rb
+- spec/logic_converters/on_off_converter_spec.rb
+- spec/logic_converters/true_false_converter_spec.rb
+- spec/logic_converters/yes_no_converter_spec.rb
 - spec/models/base_model_spec.rb
 - spec/models/class_based_model_spec.rb
 - spec/models/filesystem_based_model_spec.rb