fedux_org-stdlib 0.0.2 → 0.0.3

data/.rspec

@@ -0,0 +1,2 @@
+--format Fuubar
+--order rand

data/.simplecov

@@ -0,0 +1,8 @@
+SimpleCov.start do
+  add_filter "/features/"
+  add_filter "/spec/"
+  add_group "actions", "lib/puppet_generator/actions/"
+  add_group "actions", "lib/puppet_generator/filter/"
+  add_group "actions", "lib/puppet_generator/templates/"
+  add_group "lib", "lib/"
+end

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+gemfile: gemfiles/Gemfile.travis
+rvm:
+    - 1.9.3
+    - 2.0.0
+script: bundle exec rake test:travis_specs

data/.yardopts

@@ -0,0 +1,6 @@
+--verbose
+-
+API-GUIDE.md
+CONTRIBUTIONS.md
+LICENSE.md
+RELEASE_NOTES.md

data/Gemfile

@@ -19,6 +19,7 @@ end
 
 group :development do
   gem 'tmrb'
+  gem 'erubis'
   gem 'debugger'
   gem 'pry'
   gem 'pry-doc'

data/Rakefile

@@ -8,12 +8,14 @@ unless ENV['TRAVIS_CI'] == 'true'
   require 'yard'
   require 'rubygems/package_task'
   require 'active_support/core_ext/string/strip'
+  require 'erubis'
 end
 
 YARD::Rake::YardocTask.new() do |y|
 # y.options << '--verbose'
 end
 
+
 desc 'start tmux'
 task :terminal do
   sh "script/terminal"
@@ -30,13 +32,21 @@ namespace :version do
 
     new_version = ENV['VERSION'] || ENV['version']
 
-    raw_module_name = File.open(version_file, "r").readlines.grep(/module/).first
-    module_name = raw_module_name.chomp.match(/module\s+(\S+)/) {$1}
+    raw_module_names = File.open(version_file, "r").readlines.grep(/module/)
+    module_names = raw_module_names.collect { |n| n.chomp.match(/module\s+(\S+)/) {$1} }
+
+    template = <<-EOF
+    #main <%= @modules.first %>
+    <% @modules.each do |m| %>
+    module <%= m %>
+    <% end %>
+      VERSION = '<%= @version %>'
+    <% @modules.size.times do |m| %>
+    end
+    <% end %>
+EOF
 
-    version_string = %Q{#main #{module_name}
-module #{module_name}
-VERSION = '#{new_version}'
-end}
+    version_string = Erubis::Eruby.new(template).evaluate(modules: module_names, version: new_version)
 
     File.open(version_file, "w") do |f|
       f.write version_string.strip_heredoc

data/fedux_org-stdlib.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_dependency "activesupport"
 end

data/lib/fedux_org/stdlib/logging/logger.rb

@@ -1,3 +1,5 @@
+require 'logger'
+
 module FeduxOrg
   module Stdlib
     module Logging

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

@@ -1,3 +1,6 @@
+require 'fedux_org/stdlib/logging'
+require 'fedux_org/stdlib/models/exceptions'
+
 module FeduxOrg
   module Stdlib
     module Models
@@ -57,13 +60,9 @@ module FeduxOrg
             end
           end
 
-          def find( val )
-            @instances.find { |i| i.name == val.to_s.to_sym }
-          end
-
           def delete( val )
-            element = find( val.to_s.to_sym )
-            raise Exceptions::InstanceNotFound unless element
+            element = self.find( val.to_s.to_sym )
+            raise FeduxOrg::Stdlib::Exceptions::InstanceNotFound unless element
             @instances.delete element
 
             element

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

@@ -1,3 +1,6 @@
+require 'active_support/core_ext/string/inflections'
+require 'fedux_org/stdlib/models/filesystem_based_model'
+
 module FeduxOrg
   module Stdlib
     module Models
@@ -15,7 +18,7 @@ module FeduxOrg
           end
 
           def exception_for_model
-            "#{library_name}::Exceptions::Invalid#{model_name.singularize}".constantize
+            "#{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

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

@@ -1,32 +1,38 @@
-module PuppetGenerator
-  module Exceptions
-
-    #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 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
+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 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

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

@@ -1,3 +1,5 @@
+require 'fedux_org/stdlib/models/base_model'
+
 module FeduxOrg
   module Stdlib
     module Models

data/lib/fedux_org/stdlib/models.rb

@@ -2,4 +2,3 @@ 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'
-require 'fedux_org/stdlib/logger'

data/lib/fedux_org/stdlib/version.rb

@@ -1,6 +1,6 @@
 #main FeduxOrg
 module FeduxOrg
-  module Stdlib
-    VERSION = '0.0.2'
-  end
+module Stdlib
+  VERSION = '0.0.3'
+end
 end

data/script/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path('../lib', File.dirname(__FILE__))
+
+require 'fedux_org/stdlib'
+require 'pry'
+
+Pry.start

data/script/terminal

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'tmrb'
+
+tmux = TmRb::Multiplexer.new
+#creates an empty window
+tmux.new_session(:session_name => "fedux_org-stdlib")
+
+tmux.new_window(:name => 'models', :command => 'vim -c  \"NERDTree lib/fedux_org/stdlib/models\"')
+tmux.new_window(:name => 'logging', :command => 'vim -c  \"NERDTree lib/fedux_org/stdlib/logging\"')
+tmux.new_window(:name => 'spec', :command => 'vim -c \"NERDTree spec\"')
+tmux.start

data/spec/examples/models/class_based/forbidden_keyword.rb

@@ -0,0 +1,8 @@
+module TestIt
+  module TestClasses
+    class ForbiddenKeyword
+      def req_method
+      end
+    end
+  end
+end

data/spec/examples/models/class_based/invalid_1.rb

@@ -0,0 +1,6 @@
+module TestIt
+  module TestClasses
+    class Invalid_1
+    end
+  end
+end

data/spec/examples/models/class_based/invalid_2.rb

@@ -0,0 +1,7 @@
+module TestIt
+  module TestClasses
+    class Invalid2
+      #missing method
+    end
+  end
+end

data/spec/examples/models/class_based/valid_1.rb

@@ -0,0 +1,8 @@
+module TestIt
+  module TestClasses
+    class Valid1
+      def req_method
+      end
+    end
+  end
+end

data/spec/models/base_model_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+require 'fedux_org/stdlib/models'
+
+describe Models::BaseModel do
+
+  before(:each) {
+    Models::BaseModel.clear
+  }
+
+  it "is possible to register a message" do
+    m1 = Models::BaseModel.new('name')
+    Models::BaseModel.register m1
+  end
+
+  it "is possible to find an object" do
+    m1 = Models::BaseModel.new('name')
+    Models::BaseModel.register m1
+
+    m_found = Models::BaseModel.find('name')
+
+    expect(m1).to eq(m_found)
+  end
+
+  it "is possible to create and register in one step" do
+    m1 = Models::BaseModel.create('name')
+    m_found = Models::BaseModel.find('name')
+
+    expect(m1).to eq(m_found)
+  end
+
+  it "is possible to delete an object" do
+    m1 = Models::BaseModel.create('name')
+    m2 = Models::BaseModel.delete('name')
+
+    expect(m1).to eq(m2)
+  end
+
+  it "is possible to delete all objects" do
+    Models::BaseModel.create('name1')
+    Models::BaseModel.create('name2')
+    Models::BaseModel.create('name3')
+
+    Models::BaseModel.clear
+    expect(Models::BaseModel.all).to eq( [] )
+  end
+
+end

data/spec/models/class_based_model_spec.rb

@@ -0,0 +1,185 @@
+require 'spec_helper'
+
+require 'fedux_org/stdlib/models/class_based_model'
+
+describe Models::ClassBasedModel do
+
+  before(:each) do
+
+    module TestIt
+      module Exceptions
+        class InvalidTestClass < Exception; end
+      end
+    end
+
+  end
+
+  it "loads all available instances from the file system and make the classes available." do
+    # all loaded instances need be defined like that
+    #
+    # model: 
+    # ------
+    # class Testmodel
+    # end
+    #
+    # Class to be loaded for instance of model (second level is plural of model name)
+    # Furthermore you need to define a method which is used as a check for a valid
+    # class. That class must not take an argument in #new! All arguments need to be
+    # taken by the '#method'.
+    # --------------------------------------------------------------------------------
+    # module Bla
+    #   module Testmodels
+    #     class XY
+    #       def method
+    #       end
+    #     end
+    #   end
+    # end
+    test_class = Class.new(Models::BaseModel) do
+      include Models::FilesystemBasedModel
+      include Models::ClassBasedModel
+
+      def initialize(name, klass)
+        super(name)
+
+        @klass = klass
+      end
+
+      def self.model_name
+        'TestClass'
+      end
+
+      def self.library_name
+        'TestIt'
+      end
+
+      def self.check_method
+        :req_method
+      end
+
+      def self.path_to_instances
+        File.join( examples_dir, 'models', 'class_based', 'valid_1.rb' )
+      end
+
+      def self.require_path(name)
+        File.join( examples_dir, 'models', 'class_based', 'valid_1' )
+      end
+    end
+
+    test_class.init
+    expect(test_class.all.first.name).to eq(:valid_1)
+  end
+
+
+  it "raises an error if an instance is invalid: name error" do
+    test_class = Class.new(Models::BaseModel) do
+      include Models::FilesystemBasedModel
+      include Models::ClassBasedModel
+
+      def initialize(name, klass)
+        super(name)
+
+        @klass = klass
+      end
+
+      def self.model_name
+        "TestClass"
+      end
+
+      def self.library_name
+        'TestIt'
+      end
+
+      def self.check_method
+        :req_method
+      end
+
+      def self.path_to_instances
+        File.join( examples_dir, 'models', 'class_based', 'invalid_1.rb' )
+      end
+
+      def self.require_path(name)
+        File.join( examples_dir, 'models', 'class_based', 'invalid_1' )
+      end
+    end
+
+    expect {
+      test_class.init
+    }.to raise_error 
+  end
+
+  it "an import filter uses a forbidden keywords as name" do
+    test_class = Class.new(Models::BaseModel) do
+      include Models::FilesystemBasedModel
+      include Models::ClassBasedModel
+
+      def initialize(name, klass)
+        super(name)
+
+        @klass = klass
+      end
+
+      def self.model_name
+        "TestClass"
+      end
+
+      def self.library_name
+        'TestIt'
+      end
+
+      def self.path_to_instances
+        File.join( examples_dir, 'models', 'class_based', 'forbidden_keyword.rb' )
+      end
+
+      def self.require_path(name)
+        File.join( examples_dir, 'models', 'class_based', 'forbidden_keyword' )
+      end
+
+      def self.forbidden_keywords
+        [ :forbidden_keyword ]
+      end
+    end
+
+    expect {
+      test_class.init
+    }.to raise_error FeduxOrg::Stdlib::Models::Exceptions::UnauthorizedUseOfKeyword
+  end
+
+  it "raises an error if an import filter is invalid: missing method" do
+    test_class = Class.new(Models::BaseModel) do
+      include Models::FilesystemBasedModel
+      include Models::ClassBasedModel
+
+      def initialize(name, klass)
+        super(name)
+
+        @klass = klass
+      end
+
+      def self.model_name
+        "TestClass"
+      end
+
+      def self.library_name
+        'TestIt'
+      end
+
+      def self.path_to_instances
+        File.join( examples_dir, 'models', 'class_based', 'invalid_2.rb' )
+      end
+
+      def self.require_path(name)
+        File.join( examples_dir, 'models', 'class_based', 'invalid_2' )
+      end
+
+      def self.check_method
+        :req_method
+      end
+    end
+
+    expect {
+      test_class.init
+    }.to raise_error TestIt::Exceptions::InvalidTestClass
+  end
+
+end

data/spec/models/filesystem_based_model_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+require 'fedux_org/stdlib/models/filesystem_based_model'
+
+describe Models::FilesystemBasedModel do
+  before(:each) do
+    @model = Class.new(Models::BaseModel) do
+      include Models::FilesystemBasedModel
+
+      def self.load_from_filesystem
+        [ :hello, :world ].each { |s| create( s ) }
+      end
+    end
+
+    @model.clear
+
+    module Test123
+      module Models
+        class TestClassForFilesystem < FeduxOrg::Stdlib::Models::BaseModel
+          include FeduxOrg::Stdlib::Models::FilesystemBasedModel
+        end
+      end
+    end
+  end
+
+  it "returns a string of all active filters" do
+    @model.create(:name1)
+    @model.create(:name2)
+    @model.enable :name1
+    @model.enable :name2
+
+    result = @model.all_names_as_string(", ")
+    expect(result).to eq("name1, name2")
+
+    result = @model.all_names_as_string
+    expect(result).to eq("name1, name2")
+  end
+
+  it "finds all available filter" do
+    @model.init
+    filter = @model.find(:hello)
+    expect(filter.name).to eq(:hello)
+  end
+
+  it "is default that all found filters are disabled" do
+    @model.init
+    all_filter = @model.all
+    all_not_enabled_filter = @model.find_all(enabled: false)
+    expect(all_filter.size).to eq(all_not_enabled_filter.size)
+  end
+
+  it "enables a filter by request" do
+    @model.init
+    @model.enable(:hello)
+    all_enabled_filter = @model.find_all( enabled: true )
+    filter = @model.find( :hello )
+
+    expect( all_enabled_filter ).to eq( [ filter ] )
+  end
+
+  it "s find method supports a hash based syntax" do
+    @model.init
+    @model.enable(:hello)
+
+    enabled_filter = @model.find(name: :hello, enabled: true)
+    expect(enabled_filter.name).to eq(:hello)
+  end
+
+  it "s find method supports a symbol based syntax as well. The search string is compared against the name method." do
+    @model.init
+    enabled_filter = @model.find(:hello)
+    expect(enabled_filter.name).to eq(:hello)
+
+    enabled_filter = @model.find_all(:hello)
+    expect(enabled_filter.first.name).to eq(:hello)
+  end
+
+  it "s find method supports a string based syntax as well. The search string is compared against the name method." do
+    @model.init
+    enabled_filter = @model.find('hello')
+    expect(enabled_filter.name).to eq(:hello)
+
+    enabled_filter = @model.find_all('hello')
+    expect(enabled_filter.first.name).to eq(:hello)
+  end
+
+  it "raises an error if an unknown search criteria is used" do
+    @model.init
+    expect { 
+      enabled_filter = @model.find(unknown: 'hello')
+    }.to raise_error FeduxOrg::Stdlib::Models::Exceptions::InvalidSearchCriteria
+  end
+
+  it "returns the module name" do
+    expect( Test123::Models::TestClassForFilesystem.send(:module_name) ).to eq('Test123::Models')
+  end
+
+  it "returns the model name" do
+    expect( Test123::Models::TestClassForFilesystem.send(:model_name) ).to eq('TestClassForFilesystem')
+  end
+
+  it "returns the library name" do
+    expect( Test123::Models::TestClassForFilesystem.send(:library_name) ).to eq('Test123')
+  end
+end

data/spec/spec_helper.rb

@@ -14,8 +14,8 @@ unless ENV['TRAVIS_CI'] == 'true'
   SimpleCov.command_name 'rspec'
 end
 
-require 'puppet_generator'
-include PuppetGenerator
+require 'fedux_org/stdlib'
+include FeduxOrg::Stdlib
 
 RSpec.configure do |c|
   c.treat_symbols_as_metadata_keys_with_true_values = true
@@ -26,3 +26,4 @@ end
 def examples_dir
   File.expand_path( '../examples', __FILE__ )
 end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fedux_org-stdlib
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-05 00:00:00.000000000 Z
+date: 2013-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: collection of use full libraries
 email:
 - dev@fedux.org
@@ -51,6 +67,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .simplecov
+- .travis.yml
+- .yardopts
 - Gemfile
 - LICENSE.md
 - README.md
@@ -62,7 +82,7 @@ files:
 - lib/fedux_org/stdlib/environment.rb
 - lib/fedux_org/stdlib/filesystem.rb
 - lib/fedux_org/stdlib/filesystem/exceptions.rb
-- lib/fedux_org/stdlib/logger.rb
+- lib/fedux_org/stdlib/logging.rb
 - lib/fedux_org/stdlib/logging/logger.rb
 - lib/fedux_org/stdlib/models.rb
 - lib/fedux_org/stdlib/models/base_model.rb
@@ -70,6 +90,15 @@ files:
 - lib/fedux_org/stdlib/models/exceptions.rb
 - lib/fedux_org/stdlib/models/filesystem_based_model.rb
 - lib/fedux_org/stdlib/version.rb
+- script/console
+- script/terminal
+- spec/examples/models/class_based/forbidden_keyword.rb
+- spec/examples/models/class_based/invalid_1.rb
+- spec/examples/models/class_based/invalid_2.rb
+- spec/examples/models/class_based/valid_1.rb
+- spec/models/base_model_spec.rb
+- spec/models/class_based_model_spec.rb
+- spec/models/filesystem_based_model_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -97,5 +126,12 @@ signing_key:
 specification_version: 3
 summary: collection of use full libraries
 test_files:
+- spec/examples/models/class_based/forbidden_keyword.rb
+- spec/examples/models/class_based/invalid_1.rb
+- spec/examples/models/class_based/invalid_2.rb
+- spec/examples/models/class_based/valid_1.rb
+- spec/models/base_model_spec.rb
+- spec/models/class_based_model_spec.rb
+- spec/models/filesystem_based_model_spec.rb
 - spec/spec_helper.rb
 has_rdoc: