alki 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b62e2164cbf952d15c45aa1845bdd03afac913b0
-  data.tar.gz: 749ebc7d797b44ec3ecd900d4cb48b2e45af625d
+  metadata.gz: d43f615a01e47c804aef85ffd38c686eee21bf51
+  data.tar.gz: 87ed48fa6b70d31c1afecc2d8e79c2bced1f3faa
 SHA512:
-  metadata.gz: 56a1e7009e25e8c846f13cbeefa8e5043f3d1148675534f6082358f8ed4de0f0a53f146af5ec19219e0d9ec9ecf618abb9e290e1db731d86d28b51cd133c6ef3
-  data.tar.gz: db587ec5e1a2a6f3594ec7081729b96aa666da5bc2ebceba4c3360fa723befb900c45e9c24e07d4d4c9b29f94a49af8c644ce491f41beb27516737a8c8b62893
+  metadata.gz: 3111b599c8899e0962810df466bd66141a40720cddd03425084cb7ac8eb435a48b1212bd098449ae08fb6f2c175c70c176280b5a38b7a0afc02ca23d45f92ab4
+  data.tar.gz: 96e3b8c35bb8998d1cee45664a407c16b9f348f3140f17a69d48279835b4d84015e4f0996538a0b2607a6cba2201b909182af184f8ec14b8a26b1fe5975d74e0

data/README.md

@@ -1,4 +1,55 @@
-# Alki
+# What is Alki?
 
-Basic library for creating applications.
+Alki is a framework for creating projects that are modular, testable, and well organized.
 
+It's goal is to remove uncertainty and friction when building Ruby projects, allowing developers to focus on implementing business logic.
+
+# Synopsis
+
+Best place to start would be to check out some examples:
+
+* https://github.com/alki-project/alki-example
+* https://github.com/alki-project/alki/test/fixtures/example
+
+# The Alki Assembly
+
+If a set of classes are the raw materials of your product, an Assembly is the finished product, ready to ship.
+
+To get there, you provide Alki with your assembly definition, which acts as the instructions for how to piece together your classes and objects.
+
+Assembly definitions are written in a simple DSL and are transformed into classes.
+
+```ruby
+require 'alki'
+
+class Printer
+  def print(msg)
+    puts msg
+  end
+end
+
+MyAssembly = Alki.create_assembly do
+  service :printer do
+    Printer.new
+  end
+end
+
+MyAssembly.new.printer.print "hello world"
+```
+
+## Project Assemblies
+
+While Assemblies can be created directly as in the previous example, most
+of the time an entire project will contain instructions for a single Assembly.
+
+To ease this use case, Alki supports a simple standard project layout.
+
+* `config` and `lib` directories in your project root.
+* A file called `config/assembly.rb` with your assembly definition inside an `Alki do ... end` block.
+* A file under lib that has the name of your project. For example if your project was called `MyProject`, create a file called `lib/my_project.rb`.
+  Inside the file put the following two lines:
+  
+    ```ruby
+require 'alki'
+Alki.project_assembly!
+    ```

data/lib/alki.rb

@@ -1,12 +1,16 @@
 require 'alki/assembly_builder'
 
 module Alki
-  def self.create_assembly!(opts={},&blk)
-    opts[:path] ||= caller_locations(1,1)[0].absolute_path
-    AssemblyBuilder.build(opts,&blk)
-  end
+  class << self
+    def project_assembly!(opts={},&blk)
+      opts[:project_assembly] ||= caller_locations(1,1)[0].absolute_path
+      AssemblyBuilder.build(opts,&blk)
+    end
+
+    alias_method :create_assembly!, :project_assembly!
 
-  def self.create_assembly(opts={},&blk)
-    AssemblyBuilder.build(opts,&blk)
+    def create_assembly(opts={},&blk)
+      AssemblyBuilder.build(opts,&blk)
+    end
   end
 end

data/lib/alki/assembly_builder.rb

@@ -21,13 +21,13 @@ module Alki
       build_assembly blk if blk
       set_config_directory opts[:config_dir] if opts[:config_dir]
       set_assembly_name opts[:name] if opts[:name]
-      detect_from_path opts[:path] if opts[:path]
+      setup_project_assembly opts[:project_assembly] if opts[:project_assembly]
       load_assembly_file opts[:primary_config] unless definition
       build_empty_assembly unless definition
       build_class
     end
 
-    def detect_from_path(path)
+    def setup_project_assembly(path)
       root = Alki::Support.find_root(path) do |dir|
         File.exists?(File.join(dir,'config','assembly.rb')) ||
           File.exists?(File.join(dir,'Gemfile')) ||

data/lib/alki/version.rb

@@ -1,3 +1,3 @@
 module Alki
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/test/feature/alki_test.rb

@@ -40,17 +40,17 @@ describe Alki do
       Object.send :remove_const, :AlkiTest
     end
 
-    it 'should automatically determine config_dir and name if path provided' do
+    it 'should automatically determine config_dir and name if project_assembly provided' do
       was_defined = defined? Tlogger
       Object.send :remove_const, :Tlogger if was_defined
-      klass = build(path: fixture_path('tlogger','lib','tlogger.rb'))
+      klass = build(project_assembly: fixture_path('tlogger','lib','tlogger.rb'))
       Tlogger.must_equal klass
       klass.new.must_respond_to :log
       Object.send :remove_const, :Tlogger unless was_defined
     end
   end
 
-  describe :create_assembly! do
+  describe :project_assembly! do
     it 'should automatically set path option using path of caller' do
       require fixture_path('tlogger','lib','tlogger.rb')
       Tlogger.new.must_respond_to :log

data/test/fixtures/example/lib/example.rb

@@ -1,3 +1,3 @@
 require 'alki'
 
-Alki.create_assembly!
+Alki.project_assembly!

data/test/fixtures/tlogger/lib/tlogger.rb

@@ -1,3 +1,3 @@
 require 'alki'
 
-Alki.create_assembly!
+Alki.project_assembly!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alki
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Matt Edlefsen
@@ -121,7 +121,6 @@ files:
 - lib/alki/version.rb
 - test/feature/alki_test.rb
 - test/feature/example_test.rb
-- test/fixtures/config.rb
 - test/fixtures/example/config/assembly.rb
 - test/fixtures/example/config/handlers.rb
 - test/fixtures/example/config/settings.rb
@@ -165,7 +164,6 @@ summary: Base library for building applications.
 test_files:
 - test/feature/alki_test.rb
 - test/feature/example_test.rb
-- test/fixtures/config.rb
 - test/fixtures/example/config/assembly.rb
 - test/fixtures/example/config/handlers.rb
 - test/fixtures/example/config/settings.rb

data/test/fixtures/config.rb

@@ -1,6 +0,0 @@
-wait = $wait || 0
-$wait =nil
-Alki do
-  wait
-end
-sleep wait if wait > 0