copland 0.8.0

data/examples/solitaire-cipher/lib/cli.rb

@@ -0,0 +1,24 @@
+class CLI
+
+  ENCRYPTED = /^([A-Z]{5} )*[A-Z]{5}$/
+
+  attr_writer :cipher
+  attr_writer :options
+
+  def run
+    return unless @options.run_app?
+
+    @cipher.use_algorithm @options.keying_algorithm
+
+    @options.strings.each do |arg|
+      if arg =~ ENCRYPTED
+        puts arg.inspect
+        puts "  (decrypt)--> #{@cipher.decrypt(arg).inspect}"
+      else
+        puts arg.inspect
+        puts "  (encrypt)--> #{@cipher.encrypt(arg).inspect}"
+      end
+    end
+  end
+
+end

data/examples/solitaire-cipher/lib/package.yml

@@ -0,0 +1,106 @@
+---
+id: solitaire.cipher
+description: >-
+  The services needed to implement a command-line version of the solitaire
+  cipher. This is in fulfillment of Ruby Quiz 1: "The Solitaire Cipher".
+
+service-points:
+
+  CLI:
+    description: >-
+      The command-line interface required by the quiz. Ideally, this would
+      be put in a package of its own, leaving the more general-purpose
+      services in this package, but for the quiz...let's not go TOO overboard
+      on this...
+    model: singleton
+    implementor:
+      factory: copland.BuilderFactory
+      class: cli/CLI
+      properties:
+        cipher: !!service SolitaireCipher
+        options: !!service Options
+
+  KeyingAlgorithms:
+    description: >-
+      This service helps provide keying algorithms. It is backed by the
+      configuration point of the same name, but provides a little more "extra"
+      functionality than an unadorned configuration point.
+    implementor:
+      factory: copland.BuilderFactory
+      class: cipher/KeyingAlgorithms
+      properties:
+        algorithms: !!configuration KeyingAlgorithms
+        registry: !!service copland.Registry
+
+  KeyStream:
+    description: >-
+      Represents a keystream. It may be used as an iterator to obtain
+      subsequent letters from the keystream.
+    model: prototype
+    implementor:
+      factory: copland.BuilderFactory
+      class: cipher/KeyStream
+      properties:
+        deck: !!service Deck
+
+  SolitaireCipher:
+    description: >-
+      The implementation of the solitaire cipher. This handles both encryption
+      and decryption.
+    model: prototype
+    implementor:
+      factory: copland.BuilderFactory
+      class: cipher/SolitaireCipher
+      parameters:
+        - !!service UnkeyedAlgorithm
+      properties:
+        algorithms: !!service KeyingAlgorithms
+        stream: !!service KeyStream
+
+  UnkeyedAlgorithm:
+    description: >-
+      The default keying algorithm, which is really no algorithm at all. It
+      does nothing to the deck, leaving it in its unkeyed form.
+    implementor: cipher/UnkeyedAlgorithm
+
+  BackwardsAlgorithm:
+    description: >-
+      Keys the deck by ordering the cards in reverse unkeyed order.
+    implementor: cipher/BackwardsAlgorithm
+
+  ShuffleAlgorithm:
+    description: >-
+      Just for demonstration, and certainly not required by the quiz. This
+      keying algorithm just shuffles the deck, using a specific number to
+      seed the random number generator, for repeatability.
+    implementor:
+      factory: copland.BuilderFactory
+      class: cipher/ShuffleAlgorithm
+      properties:
+        options: !!service Options
+
+  Options:
+    description: >-
+      Represents the options given to the application, either via the command
+      line or some other way.
+    implementor: cipher/Options
+
+  Deck:
+    model: prototype-deferred
+    description: Implements a deck of cards for the solitaire cipher.
+    implementor: cipher/Deck
+
+configuration-points:
+
+  KeyingAlgorithms:
+    type: map
+    description: >-
+      The map of available algorithms to use when keying a deck. Each algorithm
+      that is added must be the (fully-qualified) name of a service.
+
+contributions:
+
+  KeyingAlgorithms:
+    unkeyed: solitaire.cipher.UnkeyedAlgorithm
+    shuffle: solitaire.cipher.ShuffleAlgorithm
+    reverse: solitaire.cipher.BackwardsAlgorithm

data/examples/solitaire-cipher/test/tc_deck.rb

@@ -0,0 +1,30 @@
+$: << File.join( File.dirname( __FILE__ ), "..", "lib" )
+require 'test/unit'
+require 'cipher'
+
+class TC_Deck < Test::Unit::TestCase
+
+  def setup
+    @deck = Deck.new
+  end
+
+  def test_content
+    expected = (1..52).to_a + [ "A", "B" ]
+    assert_equal expected, @deck.to_a
+  end
+
+  def test_shuffle
+    @deck.cipher_shuffle!
+    expected = (2..52).to_a + [ "A", "B", 1 ]
+    assert_equal expected, @deck.to_a
+  end
+
+  def test_letter
+    expected = %w{ D W J nil X H Y R F D G }
+    expected.each do |expected_letter|
+      @deck.cipher_shuffle!
+      assert_equal expected_letter, @deck.cipher_letter || "nil"
+    end
+  end
+
+end

data/examples/solitaire-cipher/test/tc_key-stream.rb

@@ -0,0 +1,19 @@
+$: << File.join( File.dirname( __FILE__ ), "..", "lib" )
+require 'test/unit'
+require 'cipher'
+
+class TC_KeyStream < Test::Unit::TestCase
+
+  def setup
+    @stream = KeyStream.new
+    @stream.deck = Deck.new
+  end
+
+  def test_next
+    expected = %w{ D W J X H Y R F D G }
+    expected.each do |expected_letter|
+      assert_equal expected_letter, @stream.next
+    end
+  end
+
+end

data/examples/solitaire-cipher/test/tc_keying-algorithms.rb

@@ -0,0 +1,31 @@
+$: << File.join( File.dirname( __FILE__ ), "..", "lib" )
+require 'test/unit'
+require 'cipher'
+
+class TC_KeyingAlgorithms < Test::Unit::TestCase
+
+  class MockRegistry
+    def service( name )
+      return "found" if name == "something.mock"
+      return nil
+    end
+  end
+
+  def setup
+    @algorithms = KeyingAlgorithms.new
+    @algorithms.algorithms = { "mock" => "something.mock" }
+    @algorithms.registry = MockRegistry.new
+  end
+
+  def test_get_not_found
+    assert_raise( RuntimeError ) do
+      @algorithms.get( "bogus" )
+    end
+  end
+
+  def test_get_found
+    svc = @algorithms.get( "mock" )
+    assert_equal svc, "found"
+  end
+
+end

data/examples/solitaire-cipher/test/tc_solitaire-cipher.rb

@@ -0,0 +1,66 @@
+$: << File.join( File.dirname( __FILE__ ), "..", "lib" )
+require 'test/unit'
+require 'cipher'
+
+class TC_SolitaireCipher < Test::Unit::TestCase
+
+  class MockAlgorithms
+    def get( name )
+      MockAlgorithm.new
+    end
+  end
+
+  class MockDeck
+    def cipher_shuffle!
+    end
+
+    def cipher_letter
+      "X"
+    end
+  end
+
+  class MockAlgorithm
+    def new_deck
+      MockDeck.new
+    end
+  end
+
+  def setup
+    @cipher = SolitaireCipher.new( UnkeyedAlgorithm.new )
+    @cipher.algorithms = MockAlgorithms.new
+    @cipher.stream = KeyStream.new
+  end
+
+  def test_use_algorithm
+    @cipher.use_algorithm "mock"
+    assert_equal "FCJJM", @cipher.encrypt( "HELLO" )
+    assert_equal "JGNNQ", @cipher.decrypt( "HELLO" )
+  end
+
+  def test_encrypt
+    msg = "Code in Ruby! Live longer."
+    expected = "GLNCQ MJAFF FVOMB JIYCB"
+    assert_equal expected, @cipher.encrypt( msg )
+  end
+
+  def test_decrypt_bad
+    assert_raise( RuntimeError ) do
+      @cipher.decrypt( "not good" )
+    end
+
+    assert_raise( RuntimeError ) do
+      @cipher.decrypt( "BOGUS 12345" )
+    end
+  end
+
+  def test_decrypt_good
+    msg = "CLEPK HHNIY CFPWH FDFEH"
+    expected = "YOURCIPHERISWORKINGX"
+    assert_equal expected, @cipher.decrypt( msg )
+
+    msg = "ABVAW LWZSY OORYK DUPVH"
+    expected = "WELCOMETORUBYQUIZXXX"
+    assert_equal expected, @cipher.decrypt( msg )
+  end
+
+end

data/examples/solitaire-cipher/test/tc_unkeyed-algorithm.rb

@@ -0,0 +1,17 @@
+$: << File.join( File.dirname( __FILE__ ), "..", "lib" )
+require 'test/unit'
+require 'cipher'
+
+class TC_UnkeyedAlgorithm < Test::Unit::TestCase
+
+  def setup
+    @algo = UnkeyedAlgorithm.new
+  end
+
+  def test_new_deck
+    expected = (1..52).to_a + [ "A", "B" ]
+    deck = @algo.new_deck
+    assert_equal expected, deck.to_a
+  end
+
+end

data/examples/solitaire-cipher/test/tests.rb

@@ -0,0 +1,2 @@
+Dir.chdir File.dirname( __FILE__ )
+Dir["tc_*.rb"].each { |test| load test }

data/lib/copland.rb

@@ -0,0 +1,56 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+#     * Redistributions of source code must retain the above copyright notice,
+#       this list of conditions and the following disclaimer.
+# 
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+# 
+#     * The names of its contributors may not be used to endorse or promote
+#       products derived from this software without specific prior written
+#       permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# =============================================================================
+#++
+
+require 'copland/configuration/errors'
+require 'copland/errors'
+require 'copland/registry'
+require 'copland/version'
+
+module Copland
+
+  # The map of library 'require' names to the package descriptor search paths
+  # that they define.
+  LIBRARIES = Hash.new { |h,k| h[k] = Array.new }
+
+  # The name of the "core" Copland library. This will always be loaded by
+  # default, but we define a library name to keep things consistent. Also to
+  # allow packages to explicitly require it, if they desire.
+  LIBRARY_NAME = "copland"
+
+  # The search paths of the core Copland library.
+  SEARCH_PATHS = [ File.join( File.dirname( __FILE__ ), "copland", "impl" ) ]
+
+  # Tell Copland how to find it's core services.
+  LIBRARIES[ LIBRARY_NAME ] = SEARCH_PATHS
+
+end

data/lib/copland/class-factory.rb

@@ -0,0 +1,95 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+#     * Redistributions of source code must retain the above copyright notice,
+#       this list of conditions and the following disclaimer.
+# 
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+# 
+#     * The names of its contributors may not be used to endorse or promote
+#       products derived from this software without specific prior written
+#       permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# =============================================================================
+#++
+
+require 'singleton'
+
+module Copland
+
+  # This factory class provides an interface for instantiating a variety
+  # of different kinds of classes. It uses the concept of a "pool" to allow
+  # different functional groupings of classes to be separated within the
+  # factory. Thus, this is _the_ factory class for all classes in Copland,
+  # including configuration points, instantiators, and service models.
+  class ClassFactory
+    include Singleton
+
+    # Create a new ClassFactory. By default, it defines no pools.
+    def initialize
+      @pools = Hash.new
+      @constructors = Hash.new
+    end
+
+    # Define a new pool with the given name. If a block is given, it should
+    # accept at least one parameter (the klass to instantiate) and should
+    # return an instance of that class. Additional parameters may be
+    # passed to the block, with the intent that they may be used to initialize
+    # the new object somehow.
+    def create_pool( name, &block )
+      block ||= proc { |k,*args| k.new( *args ) }
+      @pools[ name ] = Hash.new
+      @constructors[ name ] = block
+    end
+
+    # Retreive a reference to the pool with the given name. If no such pool
+    # exists, a NoSuchPoolException will be raised.
+    def get_pool( name )
+      pool = @pools[ name ]
+      raise NoSuchPoolException, name unless pool
+      return pool
+    end
+
+    # Register the given klass with the class factory, in the given pool, with
+    # the given name. If the given pool does not exist, a NoSuchPoolException
+    # will be raised.
+    def register( pool_name, name, klass )
+      pool = get_pool( pool_name )
+      pool[ name ] = klass
+    end
+
+    # Return a new instance of the class registered under the given name in the
+    # given pool. If any additional arguments are given to the method, they
+    # will be passed to the constructor used to instantiate the class.
+    def get( pool_name, name, *args )
+      pool = get_pool( pool_name )
+
+      klass = pool[ name ]
+      raise NoSuchRegisteredClassException, "#{pool_name}:#{name}" unless klass
+
+      constructor = @constructors[ pool_name ]
+
+      return constructor.call( klass, *args )
+    end
+
+  end
+
+end