ghaki-app 2011.11.29.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Gerald Kalafut
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README

@@ -0,0 +1,23 @@
+= Ghaki App - Ghaki App singleton helpers
+
+Ghaki App is a collection of application singleton libraries.
+
+== Download
+
+The latest version of Ghaki App can be found at
+
+* git@github.com:ghaki/ghaki-account.git
+
+== Installation
+
+The preferred method of installing Ghaki App is through its GEM file.
+
+  % [sudo] gem install ghaki-app-0.0.1.gem
+
+== License
+
+Ghaki App is released under the MIT license.
+
+== Support
+
+Contact mailto:gerald@kalafut.org

data/lib/ghaki/app/engine.rb

@@ -0,0 +1,19 @@
+require 'singleton'
+
+module Ghaki #:nodoc:
+module App   #:nodoc:
+
+  # Singleton application engine.
+  #
+  # This is a unified loading place for application level singletons.
+  #
+  # ==== Examples
+  #
+  #   require 'ghaki/app/engine'
+  #   app = Ghaki::App::Engine.instance
+
+  class Engine
+    include Singleton
+  end
+
+end end

data/lib/ghaki/app/mixable.rb

@@ -0,0 +1,78 @@
+module Ghaki #:nodoc:
+module App   #:nodoc:
+
+  module Mixable #:nodoc:
+    # ==== Examples
+    #
+    #   require 'ghaki/app/plugin'
+    #   require 'ghaki/app/mixer'
+    #
+    #   class Duck
+    #     attr_accessor :quack
+    #   end
+    #
+    #   class DuckApp < Ghaki::App::Plugin
+    #     app_plugin_accessor Duck, :duck
+    #   end
+    #
+    #   class DuckMixin
+    #      include Ghaki::App::Mixable
+    #      app_mixin_accessor DuckApp, :duck
+    #   end
+    #
+    #   class UsingDuck
+    #     include DuckMixin
+    #     def quacker
+    #       duck.quack = true
+    #     end
+    #   end
+
+    module ClassMethods
+
+      # Generate mixin attribute reader.
+      # Uses the singleton copy unless overwritten by the writer.
+
+      def app_mixin_reader klass, source, target=source
+        if klass.respond_to?(:instance)
+          class_eval <<-"END"
+            def #{target}
+              @#{target} ||= #{klass}.instance.#{source}
+            end
+          END
+          func = :instance
+        elsif klass.respond_to?(:new)
+          class_eval <<-"END"
+            def #{target}
+              @#{target} ||= #{klass}.new
+            end
+          END
+        else
+          raise ArgumentError, "Unknown Constructor: #{klass}"
+        end
+      end
+
+      # Generate mixin attribute writer.
+      # Allows the local copy of the singleton value to be overriden.
+
+      def app_mixin_writer target
+        class_exec do
+          attr_writer target
+        end
+      end
+
+      # Generate attribute reader and writer.
+
+      def app_mixin_accessor klass, source, target=source
+        app_mixin_reader klass, source, target
+        app_mixin_writer target
+      end
+
+    end
+
+    def self.included klass #:nodoc:
+      klass.extend ClassMethods
+    end
+
+  end
+
+end end

data/lib/ghaki/app/mixer.rb

@@ -0,0 +1,62 @@
+require 'ghaki/app/engine'
+
+module Ghaki #:nodoc:
+module App   #:nodoc:
+
+  module Mixer #:nodoc:
+
+    # Allows customizable engine mixin name.
+    #
+    # ==== Example
+    #
+    #   require 'ghaki/app/mixer'
+    # 
+    #   class MyWidget
+    #
+    #     include Ghaki::App::Mixer
+    #     app_engine_mixin :sys_app
+    #
+    #     def do_something
+    #       sys_app.logger.info 'doing something'
+    #     end
+    #
+    #   end
+
+    module ClassMethods
+
+      # Generate engine mixin reader in eigen class.
+
+      def app_engine_eigen_mixin name
+        class_eval <<-"END"
+          def self.#{name}
+            Ghaki::App::Engine.instance
+          end
+        END
+      end
+
+      # Generate engine mixin reader in class.
+
+      def app_engine_class_mixin name
+        class_eval <<-"END"
+          def #{name}
+            Ghaki::App::Engine.instance
+          end
+        END
+      end
+
+      # Generate engine mixins in both the class and eigen class.
+
+      def app_engine_mixin name
+        app_engine_eigen_mixin name
+        app_engine_class_mixin name
+      end
+
+    end
+
+    def self.included klass #:nodoc:
+      klass.extend ClassMethods
+    end
+
+  end
+
+end end

data/lib/ghaki/app/mixin.rb

@@ -0,0 +1,46 @@
+require 'ghaki/app/mixer'
+
+module Ghaki #:nodoc:
+module App   #:nodoc:
+
+  # Default engine mixin name.
+  #
+  # ==== Example
+  #
+  #   require 'ghaki/app/mixin'
+  #
+  #   class MyWidget
+  #     include Ghaki::App::Mixin
+  #
+  #     def do_something
+  #       app.logger.info 'did something'
+  #     end
+  #   end
+  #
+  #   class OtherWidget
+  #     extend Ghaki::App::Mixin
+  #
+  #     def self.do_something
+  #       app.logger.info 'did something else'
+  #     end
+  #   end
+
+  module Mixin
+
+    def self.included klass #:nodoc:
+      klass.class_exec do
+        include Ghaki::App::Mixer
+        app_engine_class_mixin :app
+      end
+    end
+
+    def self.extended klass #:nodoc:
+      klass.class_exec do
+        include Ghaki::App::Mixer
+        app_engine_eigen_mixin :app
+      end
+    end
+
+  end
+
+end end

data/lib/ghaki/app/plugin.rb

@@ -0,0 +1,77 @@
+require 'singleton'
+require 'ghaki/app/engine'
+
+module Ghaki #:nodoc:
+module App   #:nodoc:
+
+  # Singleton application plugin.
+  #
+  # ==== Examples
+  #
+  #   require 'ghaki/app/plugin'
+  #
+  #   class Widget
+  #     attr_accessor :size
+  #     def initialize opts={}
+  #       @size = opts[:size]
+  #     end
+  #   end
+  #
+  #   class WidgetApp < Ghaki::App::Plugin
+  #     app_plugin_make Widget, :widget
+  #   end
+  #
+  #   # Default plugin constructor options.
+  #   WidgetApp.instance.widget_defs = {
+  #     :size => 20,
+  #   }
+  #
+  #   # Actual plugin constructor options.
+  #   WidgetApp.instance.widget_opts = {
+  #     :size => 10,
+  #   }
+  #
+  #   # Generated plugin has set value.
+  #   WidgetApp.instance.widget.size #=> 10
+
+  class Plugin
+    include Singleton
+
+    protected
+
+    # Generates attribute functions for the plugin class,
+    # constructor options, and default constructor options.
+
+    def self.app_plugin_make klass, name
+      opts = "#{name}_opts".to_sym
+      defs = "#{name}_defs".to_sym
+      class_eval <<-"END"
+        attr_writer :#{defs}, :#{opts}, :#{name}
+        def #{defs}
+          @#{defs} ||= {}
+        end
+        def #{opts}
+          @#{opts} ||= self.#{defs}
+        end
+        def #{name}
+          @#{name} ||= #{klass}.new( self.#{opts} )
+        end
+      END
+    end
+
+    # Links the plugin singleton with the engine singleton.
+
+    def self.app_plugin_link source, target=source
+      inst = "#{self}.instance"
+      Ghaki::App::Engine.class_eval <<-"END"
+        def #{target}_defs      ; #{inst}.#{source}_defs      end
+        def #{target}_defs= val ; #{inst}.#{source}_defs= val end
+        def #{target}_opts      ; #{inst}.#{source}_opts      end
+        def #{target}_opts= val ; #{inst}.#{source}_opts= val end
+        def #{target}           ; #{inst}.#{source}           end
+        def #{target}=      val ; #{inst}.#{source}=      val end
+      END
+    end
+
+  end
+end end

data/spec/ghaki/app/engine_spec.rb

@@ -0,0 +1,6 @@
+require 'ghaki/app/engine'
+
+describe Ghaki::App::Engine do
+  subject { Ghaki::App::Engine }
+  it { should respond_to :instance }
+end

data/spec/ghaki/app/mixable_spec.rb

@@ -0,0 +1,83 @@
+require 'ghaki/app/plugin'
+require 'ghaki/app/mixable'
+
+describe Ghaki::App::Mixable do
+
+  class UsingMixable
+    include Ghaki::App::Mixable
+  end
+
+  describe 'class using include' do
+    subject { UsingMixable }
+    it { should respond_to :app_mixin_reader }
+    it { should respond_to :app_mixin_writer }
+    it { should respond_to :app_mixin_accessor }
+  end
+
+  class Cow
+    def initialize opts={} ; end
+  end
+
+  class TheCow < Ghaki::App::Plugin
+    app_plugin_make Cow, :cow
+    app_plugin_link :cow
+  end
+
+  describe '#app_mixin_reader' do
+
+    context 'using source only' do
+      class UsingReaderSourceOnly
+        include Ghaki::App::Mixable
+        app_mixin_reader TheCow, :cow
+      end
+      subject { UsingReaderSourceOnly.new }
+      it { should respond_to :cow }
+      it { subject.cow.should be_an_instance_of(Cow) }
+    end
+
+    context 'using source and target' do
+      class UsingReaderSourceAndTarget
+        include Ghaki::App::Mixable
+        app_mixin_reader TheCow, :cow, :bull
+      end
+      subject { UsingReaderSourceAndTarget.new }
+      it { should respond_to :bull }
+      it { subject.bull.should be_an_instance_of(Cow) }
+    end
+
+  end
+
+  describe '#app_mixin_writer' do
+    class UsingWriter
+      include Ghaki::App::Mixable
+      app_mixin_writer :cow
+    end
+    subject { UsingWriter.new }
+    it { should respond_to :cow= }
+  end
+
+  describe '#app_mixin_accessor' do
+
+    context 'using source only' do
+      class UsingAccessorSourceOnly
+        include Ghaki::App::Mixable
+        app_mixin_accessor Cow, :cow
+      end
+      subject { UsingAccessorSourceOnly.new }
+      it { should respond_to :cow }
+      it { should respond_to :cow= }
+    end
+    
+    context 'using source and target' do
+      class UsingAccessorSourceAndTarget
+        include Ghaki::App::Mixable
+        app_mixin_accessor Cow, :cow, :bull
+      end
+      subject { UsingAccessorSourceAndTarget.new }
+      it { should respond_to :bull }
+      it { should respond_to :bull= }
+    end
+
+  end
+
+end

data/spec/ghaki/app/mixer_spec.rb

@@ -0,0 +1,53 @@
+require 'ghaki/app/mixer'
+
+describe Ghaki::App::Mixer do
+
+  class TestUsing
+    include Ghaki::App::Mixer
+  end
+
+  context 'class using include' do
+    subject { TestUsing }
+    it { should respond_to :app_engine_eigen_mixin }
+    it { should respond_to :app_engine_class_mixin }
+    it { should respond_to :app_engine_mixin }
+  end
+
+  context 'using eigen mixin' do
+    class TestEigen
+      include Ghaki::App::Mixer
+      app_engine_eigen_mixin :app_eigen
+    end
+    subject { TestEigen }
+    it { should respond_to :app_eigen }
+  end
+
+  context 'using class mixin' do
+    class TestKlass
+      include Ghaki::App::Mixer
+      app_engine_class_mixin :app_klass
+    end
+    subject { TestKlass.new }
+    it { should respond_to :app_klass }
+  end
+
+  context 'using mixed mixin' do
+
+    class TestMixed
+      include Ghaki::App::Mixer
+      app_engine_mixin :app_mixed
+    end
+
+    context 'with eigen access' do
+      subject { TestMixed }
+      it { should respond_to :app_mixed }
+    end
+
+    context 'with class access' do
+      subject { TestMixed.new }
+      it { should respond_to :app_mixed }
+    end
+
+  end
+
+end

data/spec/ghaki/app/mixin_spec.rb

@@ -0,0 +1,21 @@
+require 'ghaki/app/mixin'
+
+describe Ghaki::App::Mixin do
+
+  describe 'using include' do
+    class TestInclude
+      include Ghaki::App::Mixin
+    end
+    subject { TestInclude.new }
+    it { should respond_to :app }
+  end
+
+  describe 'using extend' do
+    class TestExtend
+      extend Ghaki::App::Mixin
+    end
+    subject { TestExtend }
+    it { should respond_to :app }
+  end
+
+end

data/spec/ghaki/app/plugin_spec.rb

@@ -0,0 +1,76 @@
+require 'ghaki/app/plugin'
+
+describe Ghaki::App::Plugin do
+
+  describe 'class extended by' do
+    class UsingPlugin < Ghaki::App::Plugin ; end
+    subject { UsingPlugin }
+    it { should respond_to :app_plugin_make }
+    it { should respond_to :app_plugin_link }
+  end
+
+
+  describe '#app_plugin_make' do
+    class Chicken
+      def initialize opts={}; end
+    end
+    class ChickenApp < Ghaki::App::Plugin
+      app_plugin_make Chicken, :chicken
+    end
+    subject { ChickenApp.instance }
+    context 'using source <chicken>' do
+      context 'generates plugin' do
+        it { should respond_to :chicken }
+        it { should respond_to :chicken= }
+        it { should respond_to :chicken_opts }
+        it { should respond_to :chicken_opts= }
+        it { should respond_to :chicken_defs }
+        it { should respond_to :chicken_defs= }
+        it { subject.chicken.should be_an_instance_of(Chicken) }
+      end
+    end
+  end
+
+  class Cow
+    def initialize opts={}; end
+  end
+
+  describe '#app_plugin_link' do
+
+    context 'using source only <cow>' do
+      class CowSourceOnly < Ghaki::App::Plugin
+        app_plugin_make Cow, :cow
+        app_plugin_link :cow
+      end
+      context 'generates plugin' do
+        subject { CowSourceOnly.instance }
+        it { should respond_to :cow }
+        it { subject.cow.should be_an_instance_of(Cow) }
+      end
+      context 'updates engine' do
+        subject { Ghaki::App::Engine.instance }
+        it { should respond_to :cow }
+        it { subject.cow.should be_an_instance_of(Cow) }
+      end
+    end
+
+    context 'using source <cow> and target <bull>' do
+      class CowSourceAndTarget < Ghaki::App::Plugin
+        app_plugin_make Cow, :cow
+        app_plugin_link :cow, :bull
+      end
+      context 'generates plugin' do
+        subject { CowSourceAndTarget.instance }
+        it { should respond_to :cow }
+        it { subject.cow.should be_an_instance_of(Cow) }
+      end
+      context 'updates engine' do
+        subject { Ghaki::App::Engine.instance }
+        it { should respond_to :bull }
+        it { subject.bull.should be_an_instance_of(Cow) }
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'mocha'
+
+RSpec.configure do |cfg|
+  cfg.mock_with :mocha
+  cfg.color_enabled = true
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: ghaki-app
+version: !ruby/object:Gem::Version
+  version: 2011.11.29.1
+  prerelease: 
+platform: ruby
+authors:
+- Gerald Kalafut
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &73486440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *73486440
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &73486210 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.9.4
+  type: :development
+  prerelease: false
+  version_requirements: *73486210
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &73485980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: *73485980
+description: Collection of application singleton libraries.
+email: gerald@kalafut.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- README
+files:
+- lib/ghaki/app/engine.rb
+- lib/ghaki/app/plugin.rb
+- lib/ghaki/app/mixin.rb
+- lib/ghaki/app/mixer.rb
+- lib/ghaki/app/mixable.rb
+- README
+- LICENSE
+- spec/ghaki/app/plugin_spec.rb
+- spec/ghaki/app/mixer_spec.rb
+- spec/ghaki/app/mixin_spec.rb
+- spec/ghaki/app/mixable_spec.rb
+- spec/ghaki/app/engine_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ghaki
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: ghaki-app
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Application singleton helpers
+test_files:
+- spec/ghaki/app/plugin_spec.rb
+- spec/ghaki/app/mixer_spec.rb
+- spec/ghaki/app/mixin_spec.rb
+- spec/ghaki/app/mixable_spec.rb
+- spec/ghaki/app/engine_spec.rb
+- spec/spec_helper.rb