alki-rails 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 401649793ac23a7eef15815fdf8b5b92131a822d
-  data.tar.gz: bab6bc5a1e1b91408e51f116b67a8307dc1ddc33
+  metadata.gz: 45051ebb8bd2da6d7be68dbd16d3a3b4335376e4
+  data.tar.gz: a580d8affd5429b300e30ba5b5530d82222f830a
 SHA512:
-  metadata.gz: ec73505b12483fe5c76ae0aa716d9727e18bd4790b83fea5ec6077fcdf654a52286e7997274201458c0b9b93b35cf3d14319d7c355c864584d452c9263974cc8
-  data.tar.gz: 9f3b7298ecf271f279002add6cba5806c8af1a16dc69c3b96f2f4de30c1bfdf9f7fa0e0e33a50804fe5806313e3df0d25639ab87e85047ab5747e88daa262323
+  metadata.gz: 712474223f299549e697bdb74c84b21007944eb42cf42f2d126df4810bc7af38b8d769aba0b5edf44e181cb5b82aa7ff3ae979b5cd346ce4842322e34a629bae
+  data.tar.gz: fdf6f58c8757dee87d669fe41fe3ffb25a0ab6200af0721707c422fc0d3b60d88832a184cd5bac01121f84bad81e71945316bfd5ae879cff6097a696c2d370c4

data/README.adoc

@@ -4,7 +4,26 @@ Rails integration for Alki! Allows easily using Alki in your Rails project. Alki
 
 == Why use Alki with Rails?
 
+While Rails is a fantastic web framework, it doesn't offer a lot of tools to manage your
+core business logic. Common idioms like "Fat Model" or "Fat Controller" work ok for a while,
+but most large Rails projects get to a point where their business logic grows beyond
+Rails' basic MVC paradigm.
 
+Using Alki to manage your business logic allows your Rails code to focus on what it does best:
+serve web pages. With Alki::Rails, Alki integrates seamlessly with Rails, while also keeping
+your core code encapsulated.
+
+=== What about Rails Services?
+
+Recent versions of Rails have added an `app/services` directory as a place to put
+dedicated service objects containing your business logic.
+
+The key difference between these Rails services and Alki services is that Rails services are
+classes or modules, referenced directly by consumers when needed, while Alki services can be
+any time of object, but are typically instances of a service class.
+
+By using instances, Alki allows services to be configured and dependency injected before
+being used.
 
 == Installation
 
@@ -22,25 +41,72 @@ And then execute:
 $ bundle
 ----
 
-Create a `config/alki` directory and then create an empty Alki Assembly definition in an `assembly.rb` file inside that. 
+Finally, run the generator to create an empty `config/assembly.rb` and to make your
+assembly elements accessible in your controllers and in the console.
+
+[source]
+----
+$ bin/rails generate alki
+----
+
+== Usage
+
+Elements like services and application settings are defined in your Assembly definition
+(`config/assembly.rb`). These elements are accessible by name directly within controllers
+and the rails console.
+
+See https://github.com/alki-project/alki[here] for more documentation on how to use Alki.
 
 .config/assembly.rb
 ```ruby
 Alki do
+  group :orders do
+    service :manager do
+      require 'order_manager'
+      OrderManager.new model, payment_processor
+    end
+
+    service :model do
+      Order
+    end
+
+    service :payment_processor do
+      require 'stripe_processor'
+      StripeProcessor.new
+    end
+  end
+end
+```
 
+.app/controllers/orders_controller.rb
+```ruby
+class OrdersController < ApplicationController
+  def post
+    @order = orders.manager.place_order params[:order]
+  end
 end
 ```
 
-Finally, add the following to your ApplicationController class:
+.lib/order_manager.rb
+```ruby
+class OrderManager
+  def initialize(model,payment_processor)
+    @model = model
+    @payment_processor = payment_processor
+  end
 
-[source,ruby]
-----
-include Alki::Rails
-----
+  ...
+end
+```
 
-== Usage
+.lib/stripe_processor.rb
+```ruby
+class StripeProcessor
+  ...
+end
+```
 
-Element defined in your Assembly definition will be callable directly from your assembly:
+Elements can also be accessed anywhere in your Rails application, via `Alki::Rails`:
 
 .config/assembly.rb
 ```ruby
@@ -51,26 +117,16 @@ Alki do
 end
 ```
 
-.app/controllers/home_controller.rb
-```ruby
-class HomeController < ApplicationController
-  def show
-    @msg = settings.msg
-  end
-end
-```
-
-Elements can also be accessed in the Rails console, or anywhere else in your Rails application, via Alki::Rails:
-
 .Rails Console
 ```
+2.3.2 :001 > settings.msg
+ => 'Hello World'
 2.3.2 :001 > Alki::Rails.settings.msg
  => 'Hello World'
 ```
 
 Alki will automatically add your projects `lib` directory to the ruby load path, so you can require files from there directly. It also will handle auto-reloading files in lib.
 
-See https://github.com/alki-project/alki[here] for more documentation on how to use Alki.
 
 == Contributing
 

data/lib/alki/rails/version.rb

@@ -1,5 +1,5 @@
 module Alki
   module Rails
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/rails/generators/alki_generator.rb

@@ -0,0 +1,18 @@
+class AlkiGenerator < Rails::Generators::Base
+  def create_initializer
+    create_file "config/assembly.rb", <<END
+Alki do    
+  # elements go here ...
+end
+END
+    create_file "config/initializers/alki.rb", <<END
+module Rails::ConsoleMethods
+  include Alki::Rails
+end
+
+class ActionController::Base
+  include Alki::Rails
+end
+END
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alki-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Matt Edlefsen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-05 00:00:00.000000000 Z
+date: 2017-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,6 +83,7 @@ files:
 - lib/alki-rails.rb
 - lib/alki/rails.rb
 - lib/alki/rails/version.rb
+- lib/rails/generators/alki_generator.rb
 homepage: https://github.com/alki-project/alki-rails
 licenses:
 - MIT