fedux_org-stdlib 0.0.31 → 0.0.32

data/lib/fedux_org/stdlib/filesystem.rb

@@ -47,7 +47,7 @@ module FeduxOrg
 
       # Create directory(ies)
       #
-      # @param [String,Array] dir
+      # @param [String,Array] dirs
       #   the directories to be created, multiple arguments are possible as well
       #
       # @return [String,Array] 
@@ -68,7 +68,7 @@ module FeduxOrg
 
       # Delete directory(ies)
       #
-      # @param [String, Array] dir
+      # @param [String, Array] dirs
       #   the directories to be deleted, multiple arguments are possible as well
       #
       # @return [String,Array] 
@@ -114,7 +114,7 @@ module FeduxOrg
 
       # Create a single file
       #
-      # @param [String] file_path
+      # @param [String] path
       #   the path for the new file (can include directories)
       #
       # @param [String] content
@@ -140,14 +140,11 @@ module FeduxOrg
 
       # Delete a single file
       #
-      # @param [String] file_path
+      # @param [String] files
       #   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
+      #   the path to the deleted file
       def delete_file(*files)
         raise_if_forbidden_path_for_delete_operation(files)
 
@@ -163,7 +160,7 @@ module FeduxOrg
 
       # Read the content of a file
       #
-      # @param [String] file_path
+      # @param [String] path
       #   the path to the file
       #
       # @return [String,Binary] 
@@ -236,7 +233,7 @@ module FeduxOrg
       # @param [Array, String] paths
       #   the paths to be checked
       #
-      # @result [TrueClass, FalseClass] 
+      # @return [TrueClass, FalseClass] 
       #   true if path is valid, false if invalid
       def path_matches?(strings, regex, *paths)
         flattend_paths = paths.flatten

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

@@ -19,6 +19,8 @@ module FeduxOrg
                          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

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

@@ -9,6 +9,15 @@ module FeduxOrg
         #   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

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

@@ -9,6 +9,14 @@ module FeduxOrg
         #   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

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

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

@@ -8,6 +8,15 @@ module FeduxOrg
         #   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

data/lib/fedux_org/stdlib/version.rb

@@ -1,6 +1,6 @@
 #main FeduxOrg
 module FeduxOrg
 module Stdlib
-  VERSION = '0.0.31'
+  VERSION = '0.0.32'
 end
 end

data/spec/logic_converters/y_n_converter_spec.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fedux_org-stdlib
 version: !ruby/object:Gem::Version
-  version: 0.0.31
+  version: 0.0.32
   prerelease: 
 platform: ruby
 authors:
@@ -95,6 +95,7 @@ files:
 - 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/y_n_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
@@ -141,6 +142,7 @@ files:
 - 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/y_n_converter_spec.rb
 - spec/logic_converters/yes_no_converter_spec.rb
 - spec/models/base_model_spec.rb
 - spec/models/class_based_model_spec.rb
@@ -187,6 +189,7 @@ test_files:
 - 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/y_n_converter_spec.rb
 - spec/logic_converters/yes_no_converter_spec.rb
 - spec/models/base_model_spec.rb
 - spec/models/class_based_model_spec.rb