abc 0.0.2

data/lib/abc.rb

@@ -0,0 +1,7 @@
+# Abc is the Afterburner CMS namespace.
+module Abc
+end
+
+require 'abc/base_conductor'
+require 'abc/base_interactor'
+

data/lib/abc/base_conductor.rb

@@ -0,0 +1,63 @@
+module Abc
+  class ResponseNotSpecifiedError < StandardError; end
+  class DataNotSpecifiedError < StandardError; end
+  # The Base Conductor is the conductor that all other conductors inherit from.
+  # Its primary role is to decipher the parameters, retrieve or save data to
+  # or from data-facing APIs like a database or a third-party API, and to 
+  # optionally wrap what it plans to return in an object that provides methods
+  # for access (in some cases, abstracting complex logic away from the view).
+  #
+  # The Conductor is not responsible, however, for validating or wrapping the
+  # data it retrieves. That task is delegated down to the application.
+  class BaseConductor
+    class << self
+      # Runs the conductor and returns a hash of objects (presenter or
+      # otherwise) that are passed to the view.
+      #
+      # @param params [HashWithIndifferentAccess] The request parameters.
+      # @param options [Hash] A series of options that override default values.
+      # @return [Hash] An associative array of presenter objects to be passed to the view.
+      def call(params, options = {})
+        new(params, options).to_response
+      end
+    end
+
+    # Transforms the data returned by the #data method into an acceptable format
+    # to return to the controller. Primarily used to wrap data in presenters, but
+    # can pass entities back, too.
+    #
+    # @return [Hash] An associative array of presenter or entity objects to be passed to the view.
+    def to_response
+      raise ResponseNotSpecifiedError, "#to_response must be overridden when subclassing BaseConductor"
+    end
+
+    protected
+    attr_accessor :params, :options
+
+    def initialize(params, options = {})
+      self.params = params
+      self.options = defaults.merge(options)
+    end
+
+    # Passes data retrieved from somewhere down to Interactors and returns something
+    # to be wrapped by #to_response -- by convention, an associative array.
+    # 
+    # This method can also assume responsibility for retrieving objects, but it may
+    # choose to delegate that to other methods of this class.
+    #
+    # @return [Object] Data to be wrapped to send in response to the request.
+    def data
+      raise DataNotSpecifiedError, "#data must be overridden when subclassing BaseConductor."
+    end
+
+    # Provides a frozen hash of sane defaults that can be overridden to change class
+    # behaviour. Highly useful for dependency injection to simplify testing. For
+    # instance, instead of hard-coding a repository object, specify a default for it
+    # so that you can pass in a mock when testing.
+    #
+    # @return [Hash] An associative array of defaults.
+    def defaults
+      Hash.new.freeze
+    end
+  end
+end

data/lib/abc/base_conductor_spec.rb

@@ -0,0 +1,9 @@
+require 'shared/callable'
+require 'abc/base_conductor'
+
+module Abc
+  describe BaseConductor do
+    subject { BaseConductor }
+    it_behaves_like "a callable"
+  end
+end

data/lib/abc/base_interactor.rb

@@ -0,0 +1,17 @@
+module Abc
+  class BaseInteractor
+    class << self
+      def call(data, options = {})
+        new(data, options).to_response
+      end
+    end
+
+    def to_response
+      raise "#to_response must be specified!"
+    end
+
+    protected
+    def initialize(data, options = {})
+    end
+  end
+end

data/lib/abc/package.rb

@@ -0,0 +1,11 @@
+module Abc
+  RAILS_VERSION = '>= 4.0.0.beta'
+  VERSION       = '0.0.2'
+  AUTHORS       = ["The Afterburner CMS Team"]
+  EMAILS        = ["info@afterburnercms.com"]
+  HOMEPAGE      = "http://www.afterburnercms.com/"
+  SUMMARY       = "An easy-to-use, easy-to-extend CMS."
+  DESCRIPTION   = SUMMARY
+
+
+end

data/script/bundle

@@ -0,0 +1,2 @@
+#!/bin/bash
+$(cd $(dirname "$0") && pwd)/run bundle $@

data/script/projects

@@ -0,0 +1,2 @@
+#!/bin/bash
+echo "./ adapters core delivery/backend delivery/frontend"

data/script/rspec

@@ -0,0 +1,2 @@
+#!/bin/bash
+"$(cd $(dirname "$0") && pwd)"/run bundle exec rspec spec --colour

data/script/run

@@ -0,0 +1,8 @@
+#!/bin/bash
+DIR="$(cd $(dirname "$0") && pwd)"
+PROJECTS=`$DIR/projects`
+for PROJECT in ${PROJECTS[@]}
+do
+  echo "cd $(cd $DIR/../$PROJECT && pwd) && $@"
+  cd $(cd $DIR/../$PROJECT && pwd) && $@
+done

data/spec/lib/abc/base_interactor_spec.rb

@@ -0,0 +1,11 @@
+# require 'spec_helper'
+require 'shared/callable'
+require 'abc/base_interactor'
+
+module Abc
+  describe BaseInteractor do
+    subject { BaseInteractor }
+
+    it_behaves_like "a callable"
+  end
+end

data/spec/shared/callable.rb

@@ -0,0 +1,24 @@
+shared_examples "a callable" do
+  it "is not publicly instantiable" do
+    subject.new({}).should raise_error NoMethodError
+  end
+
+  describe "::call" do
+    it "returns with #to_response" do
+      mock = double "object"
+      mock.should_receive(:to_response)
+      subject.stub!(:new).and_return(mock)
+      subject.call({:stub => 'abc'})
+    end
+  end
+
+  describe "#new" do
+    it "receives the data passed to call" do
+      args = %w(andaone andatwo)
+      instance = subject.send(:new, args)
+      instance.stub!(:to_response).and_return(nil)
+      subject.should_receive(:new).with(*args).and_return(instance)
+      subject.call(*args)
+    end
+  end
+end

data/yard/setup.rb

@@ -0,0 +1,10 @@
+require File.expand_path('../lib/abc/package', File.dirname(__FILE__))
+
+this_dir = File.dirname(__FILE__)
+
+YARD::Templates::Engine.register_template_path(this_dir + '/templates')
+
+Dir[this_dir + '/handlers/*.rb'].each do |file|
+  require File.expand_path(file)
+end
+YARD::Parser::SourceParser.parser_type = :ruby19

data/yard/templates/default/fulldoc/html/css/common.css

@@ -0,0 +1,109 @@
+/* Overrides for yard documentation */
+
+/* Clearfix */
+.clearfix:after {
+	content: ".";
+	display: block;
+	clear: both;
+	visibility: hidden;
+	line-height: 0;
+	height: 0;
+}
+
+.clearfix {
+	display: inline-block;
+}
+
+html[xmlns] .clearfix {
+	display: block;
+}
+
+* html .clearfix {
+	height: 1%;
+}
+ /************/
+
+body {
+  font-family: "PT Sans",Verdana,Arial,sans-serif;
+  font-size: 14px;
+}
+
+pre, code, .code,
+#filecontents pre.code,
+.docstring pre.code,
+.source_code pre {
+  font-family: Inconsolata,Monaco,"Courier New","DejaVu Sans Mono","Bitstream Vera Sans Mono",monospace;
+}
+
+pre.code, code {
+  background:#F5F5FF;
+  overflow-x: auto;
+}
+#filecontents pre.code {
+  margin:10px 0;
+  padding:5px 12px;
+  border-radius:5px;
+  -webkit-border-radius:5px;
+  -moz-border-radius:5px;
+  border: 1px dotted #CCC;
+}
+
+code .val {
+  color:#036A07;
+}
+code .kw {
+  color:#0000FF;
+}
+code .symbol {
+  color:#C5060B;
+}
+
+ul.main_files {
+  list-style-type:none;
+  margin:0;
+  padding:0;
+  font-size:14px;
+}
+ul.main_files li {
+  margin:0;
+  padding:0;
+}
+
+ul.main_files li a {
+  margin: 0;
+  padding:3px 12px;
+  display:block;
+  cursor:pointer;
+}
+#content ul.main_files li a:hover {
+  background-color:#F4F9E4;
+}
+/* Layout */
+#header,
+#content,
+#footer {
+  margin:0 auto;
+  width:1000px;
+}
+#header #logo {
+  float:left;
+  width:50%;
+  font-size: 32px;
+  letter-spacing: -1px;
+  margin-top: 20px;
+}
+#header #search {
+  position:static;
+  float:right;
+}
+#content .col1 {
+  float:left;
+  width: 750px;
+}
+#content .col2 {
+  float:left;
+  margin: 0 0 0 20px;
+  padding: 0 0 0 20px;
+  width: 200px;
+  border-left: 1px dotted #D5D5D5;
+}

data/yard/templates/default/layout/html/layout.erb

@@ -0,0 +1,56 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <%= erb(:headers) %>
+    <link rel="stylesheet" type="text/css" href="http://fonts.googleapis.com/css?family=Inconsolata">
+    <link rel="stylesheet" type="text/css" href="http://fonts.googleapis.com/css?family=PT+Sans">
+    <script type="text/javascript" charset="utf-8">
+      (function($){
+        // YARD automatically creates a table of contents
+        // Let's place it inside .col1, instead of #content
+        $(document).ready(function(){
+          $('#toc').prependTo($('.col1'));
+          <% if options[:file] == 'extra_docs/Index.md' %>
+            $('#toc').hide();
+          <% end %>
+        });
+      })(jQuery);
+    </script>
+  </head>
+  <body>
+
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+
+    <div id="header" class="clearfix">
+      <%#= erb(:breadcrumb) %>
+      <div id="logo">Afterburner CMS (v <%= Abc::VERSION %>)</div>
+      <%= erb(:search) %>
+    </div>
+
+    <div>
+      <iframe id="search_frame"></iframe>
+    </div>
+
+    <div id="content" class="clearfix">
+      <div class="col1">
+        <%= yieldall %>
+      </div>
+      <div class="col2">
+        <ul class="main_files clearfix">
+          <%= [
+            ['README', 'README'],
+            ['architecture', 'Architecture Details']
+          ].map{|(file, text)|
+            "<li>#{link_file(file, text)}</li>"
+          }.join
+          %>
+        </ul>
+      </div>
+    </div>
+
+    <%= erb(:footer) %>
+  </body>
+</html>

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: abc
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- The Afterburner CMS Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-18 00:00:00.000000000 Z
+dependencies: []
+description: An easy-to-use, easy-to-extend CMS.
+email:
+- info@afterburnercms.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- abc.gemspec
+- adapters/Gemfile
+- adapters/Rakefile
+- adapters/abc-adapters.gemspec
+- adapters/abc/adapters/persistence/repositories/base.rb
+- adapters/abc/adapters/persistence/repositories/page.rb
+- adapters/abc/adapters/persistence/repositories/text.rb
+- adapters/lib/abc-adapters.rb
+- adapters/lib/adapters/config.rb
+- adapters/spec/adapters/persistence/repositories/base_spec.rb
+- adapters/spec/adapters/persistence/repositories/page_spec.rb
+- adapters/spec/adapters/persistence/repositories/text_spec.rb
+- adapters/spec/lib/adapters/config_spec.rb
+- adapters/spec/spec_helper.rb
+- contributing.md
+- core/Gemfile
+- core/Guardfile
+- core/Rakefile
+- core/abc-core.gemspec
+- core/abc/entities/content/text.rb
+- core/abc/entities/menu/menu.rb
+- core/abc/entities/menu/menu_entry.rb
+- core/abc/entities/menu/menuable.rb
+- core/abc/entities/menu/path.rb
+- core/abc/entities/pages/page.rb
+- core/abc/entities/view/viewable.rb
+- core/abc/entities/view/viewable_presenter.rb
+- core/abc/interactors/creates_menu.rb
+- core/abc/interactors/pages/builds_page.rb
+- core/lib/abc-core.rb
+- core/spec/entities/content/text_spec.rb
+- core/spec/entities/menu/menu_entry_spec.rb
+- core/spec/entities/menu/menu_spec.rb
+- core/spec/entities/menu/menuable_spec.rb
+- core/spec/entities/menu/path_spec.rb
+- core/spec/entities/pages/page_spec.rb
+- core/spec/entities/view/viewable_presenter_spec.rb
+- core/spec/entities/view/viewable_spec.rb
+- core/spec/interactors/creates_menu_spec.rb
+- core/spec/interactors/pages/builds_page_spec.rb
+- core/spec/spec_helper.rb
+- delivery/backend/Gemfile
+- delivery/backend/Guardfile
+- delivery/backend/Rakefile
+- delivery/backend/abc-backend.gemspec
+- delivery/backend/app/controllers/abc/application_controller.rb
+- delivery/backend/app/controllers/abc/backend/base_controller.rb
+- delivery/backend/app/presenters/abc/html/menu_entry_presenter.rb
+- delivery/backend/app/presenters/abc/html/menu_presenter.rb
+- delivery/backend/app/views/abc/backend/base/index.html.erb
+- delivery/backend/config.ru
+- delivery/backend/config/routes.rb
+- delivery/backend/lib/abc-backend.rb
+- delivery/backend/lib/abc/backend/engine.rb
+- delivery/backend/spec/integration/backend_spec.rb
+- delivery/backend/spec/integration/menu_spec.rb
+- delivery/backend/spec/internal/config/database.yml
+- delivery/backend/spec/internal/config/routes.rb
+- delivery/backend/spec/internal/db/schema.rb
+- delivery/backend/spec/internal/log/.gitignore
+- delivery/backend/spec/internal/public/favicon.ico
+- delivery/backend/spec/presenters/html/menu_entry_presenter_spec.rb
+- delivery/backend/spec/presenters/html/menu_presenter_spec.rb
+- delivery/backend/spec/spec_helper.rb
+- delivery/backend/spec/tiny_spec_helper.rb
+- delivery/frontend/Gemfile
+- delivery/frontend/Guardfile
+- delivery/frontend/Rakefile
+- delivery/frontend/abc-frontend.gemspec
+- delivery/frontend/app/conductors/abc/frontend/conductors/shows_page.rb
+- delivery/frontend/app/controllers/abc/application_controller.rb
+- delivery/frontend/app/controllers/abc/frontend/base_controller.rb
+- delivery/frontend/app/controllers/abc/frontend/pages_controller.rb
+- delivery/frontend/app/presenters/abc/html/page_presenter.rb
+- delivery/frontend/app/views/abc/frontend/base/index.html.erb
+- delivery/frontend/app/views/abc/frontend/pages/show.html.haml
+- delivery/frontend/config.ru
+- delivery/frontend/config/routes.rb
+- delivery/frontend/lib/abc-frontend.rb
+- delivery/frontend/lib/abc/frontend/engine.rb
+- delivery/frontend/spec/conductors/abc/frontend/shows_page_spec.rb
+- delivery/frontend/spec/integration/backend_spec.rb
+- delivery/frontend/spec/integration/pages_spec.rb
+- delivery/frontend/spec/internal/config/database.yml
+- delivery/frontend/spec/internal/config/routes.rb
+- delivery/frontend/spec/internal/db/schema.rb
+- delivery/frontend/spec/internal/log/.gitignore
+- delivery/frontend/spec/internal/public/favicon.ico
+- delivery/frontend/spec/presenters/html/page_presenter_spec.rb
+- delivery/frontend/spec/spec_helper.rb
+- delivery/frontend/spec/tiny_spec_helper.rb
+- documentation/architecture.md
+- documentation/architecture.png
+- documentation/architecture.svg
+- lib/abc.rb
+- lib/abc/base_conductor.rb
+- lib/abc/base_conductor_spec.rb
+- lib/abc/base_interactor.rb
+- lib/abc/package.rb
+- script/bundle
+- script/projects
+- script/rspec
+- script/run
+- spec/lib/abc/base_interactor_spec.rb
+- spec/shared/callable.rb
+- yard/setup.rb
+- yard/templates/default/fulldoc/html/css/common.css
+- yard/templates/default/layout/html/layout.erb
+homepage: http://www.afterburnercms.com/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: An easy-to-use, easy-to-extend CMS.
+test_files:
+- spec/lib/abc/base_interactor_spec.rb
+- spec/shared/callable.rb
+has_rdoc: