lotusrb 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e0890eb6c32566368913554cabd9edeb2f00304
-  data.tar.gz: 248452822b63ecc6ceb19224fa837d46bb3f5686
+  metadata.gz: 320e113169441d3fdb7bb851a72be8f17de2ec49
+  data.tar.gz: 89278bf192dad6ddeb32eba05f20fd140d455448
 SHA512:
-  metadata.gz: 733c6c3d35a5939982b130b71d7cafd10ab78efa01594fac918adcbdce3bfd87d7ce8e9311c3b937aeccf93761ddb6704b8f02403092ca6ad54382a8b2f5a09b
-  data.tar.gz: 59be6d52f37a14ca8d7190528496bc46ce67ee0f29745a38d3ee6459ea9f7cbf88cecd08f3987fa872726f5fdef3518a67166ad4a121ebf14558d6df05a323de
+  metadata.gz: 8f603661a19cc39c20aefa34afc8e150b0c1beb3d833658c4b075035b8fadb9c1d565f4b98907ff9ad4e44d71bec591f5542ca1c45e79a6b447ef2cf1ed24aa7
+  data.tar.gz: a29f1c9c800a857ce759e5d61618ee366afdb710dae60bc628142311d9a5daaf8904791cd023c77f538a3525f5f5a91fd4008064d6319f73449016f1cbcd0e4c

data/CHANGELOG.md

@@ -1,6 +1,21 @@
 # Lotus
 A complete web framework for Ruby
 
+## v0.2.1 - 2015-02-06
+### Added
+- [Huy Do] Introduced `Lotus::Logger`
+- [Jimmy Zhang] `lotus new` accepts a `--path` argument
+- [Jimmy Zhang] Application generator for the current directory (`lotus new .`). This is useful to provide a web deliverable for existing Ruby gems.
+- [Trung Lê] Add example mapping file for application generator: `lib/config/mapping.rb`
+- [Hieu Nguyen] RSpec support for application generator: `--test=rspec` or `--test=minitest` (default)
+
+### Fixed
+- [Luca Guidi] `lotus version` to previx `v` (eg `v0.2.1`)
+- [Rob Yurkowski] Ensure application name doesn't contain special or forbidden characters
+- [Luca Guidi] Ensure all the applications are loaded in console
+- [Trung Lê] Container architecture: preload only `lib/<appname>/**/*.rb`
+- [Hieu Nguyen] Fixed `lotus new` to print usage when application name isn't provided
+
 ## v0.2.0 - 2014-06-23
 ### Added
 - [Luca Guidi] Introduced `lotus new` as a command to generate applications. It supports "container" architecture for now.

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Luca Guidi
+Copyright © 2014-2015 Luca Guidi
 
 MIT License
 

data/README.md

@@ -384,4 +384,4 @@ __Lotus__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Copyright
 
-Copyright 2014 Luca Guidi – Released under MIT License
+Copyright © 2014-2015 Luca Guidi – Released under MIT License

data/lib/lotus/application.rb

@@ -145,7 +145,14 @@ module Lotus
       Lotus::Loader.new(application).load!
     end
 
-    # Preload all the registered applications
+    # Preload all the registered applications, by yielding their configurations
+    # and preparing the frameworks.
+    #
+    # This is useful for testing suites, where we want to make Lotus frameworks
+    # ready, but not preload applications code.
+    #
+    # This allows to test components such as views or actions in isolation and
+    # to have faster boot times.
     #
     # @return [void]
     #
@@ -154,6 +161,24 @@ module Lotus
       synchronize do
         applications.each(&:load!)
       end
+
+      nil
+    end
+
+    # Full preload for all the registered applications.
+    #
+    # This is useful in console where we want all the application code available.
+    #
+    # @return [void]
+    #
+    # @since 0.2.1
+    # @api private
+    def self.preload_applications!
+      synchronize do
+        applications.each { |app| app.new }
+      end
+
+      nil
     end
 
     # Return the configuration for this application

data/lib/lotus/application_name.rb

@@ -0,0 +1,99 @@
+module Lotus
+  # An application name.
+  #
+  # @since 0.2.1
+  class ApplicationName
+
+    # A list of words that are prohibited from forming the application name
+    #
+    # @since 0.2.1
+    RESERVED_WORDS = %w(lotus).freeze
+
+
+    # Initialize and check against reserved words
+    #
+    # An application name needs to be translated in quite a few ways:
+    # First, it must be checked against a list of reserved words and rejected
+    # if it is invalid. Secondly, assuming it is not invalid, it must be able
+    # to be output roughly as given, but with the following changes:
+    #
+    # 1. downcased,
+    # 2. with surrounding spaces removed,
+    # 3. with internal whitespace rendered as underscores
+    # 4. with underscores de-duplicated
+    #
+    # which is the default output. It must also be transformable into an
+    # environment variable.
+    #
+    # @return [Lotus::ApplicationName] a new instance of the application name
+    #
+    # @since 0.2.1
+    def initialize(name)
+      @name = sanitize(name)
+      ensure_validity!
+    end
+
+
+    # Returns the cleaned application name.
+    #
+    # @example
+    #   ApplicationName.new("my-App ").to_s # => "my-app"
+    #
+    # @since 0.2.1
+    def to_s
+      @name
+    end
+
+
+    # Returns the application name uppercased with non-alphanumeric characters
+    # as underscores.
+    #
+    # @example
+    #   ApplicationName.new("my-app").to_env_s => "MY_APP"
+    #
+    # @since 0.2.1
+    def to_env_s
+      @name.upcase.gsub(/\W/, '_')
+    end
+
+
+    # Returns true if a potential application name matches one of the reserved
+    # words.
+    #
+    # @example
+    #   Lotus::ApplicationName.invalid?("lotus") # => true
+    #
+    # @since 0.2.1
+    def self.invalid?(name)
+      RESERVED_WORDS.include?(name)
+    end
+
+
+    private
+
+    # Raises RuntimeError with explanation if the provided name is invalid.
+    #
+    # @api private
+    # @since 0.2.1
+    def ensure_validity!
+      if self.class.invalid?(@name)
+        raise RuntimeError,
+          "application name must not be any one of the following: " +
+          RESERVED_WORDS.join(", ")
+      end
+    end
+
+
+    # Cleans a string to be a functioning application name.
+    #
+    # @api private
+    # @since 0.2.1
+    def sanitize(name)
+      name
+        .downcase
+        .strip
+        .gsub(/\s/, '_')
+        .gsub(/_{2,}/, '_')
+    end
+  end
+end

data/lib/lotus/cli.rb

@@ -8,7 +8,7 @@ module Lotus
 
     desc 'version', 'prints Lotus version'
     def version
-      puts Lotus::VERSION
+      puts "v#{ Lotus::VERSION }"
     end
 
     desc 'server', 'starts a lotus server'
@@ -61,14 +61,16 @@ module Lotus
     end
 
     desc 'new', 'generates a new application'
-    method_option :architecture,   aliases: '-a', desc: 'application architecture', type: :string,  default: 'container'
-    method_option :application,                   desc: 'application name',         type: :string,  default: 'web'
-    method_option :application_base_url,          desc: 'application base url',     type: :string,  default: '/'
-    method_option :lotus_head,                    desc: 'use Lotus HEAD',           type: :boolean, default: false
+    method_option :architecture,   aliases: '-a', desc: 'application architecture',   type: :string,  default: 'container'
+    method_option :application,                   desc: 'application name',           type: :string,  default: 'web'
+    method_option :application_base_url,          desc: 'application base url',       type: :string,  default: '/'
+    method_option :path,                          desc: 'path',                       type: :string
+    method_option :test,                          desc: 'application test framework (rspec/minitest)', type: :string,  default: 'minitest'
+    method_option :lotus_head,                    desc: 'use Lotus HEAD',             type: :boolean, default: false
     method_option :help,           aliases: '-h', desc: 'displays the usage method'
 
     def new(name = nil)
-      if options[:help]
+      if options[:help] || name.nil?
         invoke :help, ['new']
       else
         require 'lotus/commands/new'

data/lib/lotus/commands/console.rb

@@ -28,7 +28,7 @@ module Lotus
 
         # Add convenience methods to the main:Object binding
         TOPLEVEL_BINDING.eval('self').send(:include, Methods)
-        Lotus::Application.preload!
+        Lotus::Application.preload_applications!
 
         engine.start
       end

data/lib/lotus/commands/new.rb

@@ -1,4 +1,5 @@
 require 'pathname'
+require 'lotus/application_name'
 require 'lotus/utils/string'
 require 'lotus/utils/class'
 
@@ -9,12 +10,12 @@ module Lotus
 
       attr_reader :app_name, :source, :target, :cli, :options
 
-      def initialize(app_name, environment, cli)
-        @app_name = app_name
+      def initialize(app_name_or_path, environment, cli)
+        @app_name = ApplicationName.new(_get_real_app_name(app_name_or_path))
         @options  = environment.to_options
         @arch     = @options.fetch(:architecture)
 
-        @target   = Pathname.pwd.join(@app_name)
+        @target   = Pathname.pwd.join(@options.fetch(:path, app_name_or_path))
         @source   = Pathname.new(@options.fetch(:source) { ::File.dirname(__FILE__) + '/../generators/application/' }).join(@arch)
 
         @cli      = cli
@@ -27,6 +28,15 @@ module Lotus
       def start
         @command.start
       end
+
+      private
+      def _get_real_app_name(app_name_or_path)
+        if app_name_or_path.include?(::File::SEPARATOR)
+          raise ArgumentError.new("Invalid application name. If you want to set application path, please use --path option")
+        end
+
+        app_name_or_path == '.' ? ::File.basename(Dir.getwd) : app_name_or_path
+      end
     end
   end
 end

data/lib/lotus/config/sessions.rb

@@ -17,7 +17,7 @@ module Lotus
 
       # Localhost string for detecting localhost host configuration
       #
-      # @since x.x.x
+      # @since 0.2.0
       # @api private
       BLACKLISTED_DOMAINS = %w(localhost).freeze
 

data/lib/lotus/frameworks.rb

@@ -1,29 +1,10 @@
 require 'lotus/router'
 require 'lotus/view'
 require 'lotus/controller'
+require 'lotus/action/glue'
 
-module Lotus
-  module Frameworks
-    module Action
-      module Rack
-        ENV_KEY = 'lotus.action'.freeze
-
-        protected
-        def finish
-          super
-          @_env[ENV_KEY] = self
-        end
-      end
-    end
-  end
-end
-
-Lotus::Action::Rack.class_eval do
-  prepend Lotus::Frameworks::Action::Rack
-end
-
-Lotus::Action.class_eval do
-  def to_rendering
-    exposures.merge(format: format)
+Lotus::Controller.configure do
+  prepare do
+    include Lotus::Action::Glue
   end
 end

data/lib/lotus/generators/application/container/Gemfile.tt

@@ -18,6 +18,7 @@ gem 'lotus-model', '<%= config[:lotus_model_version] %>'
 
 group :test do
 <%- if config[:test] == 'rspec' -%>
+  gem 'rspec'
 <%- else -%>
   gem 'minitest'
 <%- end -%>

data/lib/lotus/generators/application/container/Rakefile.rspec.tt

@@ -0,0 +1,5 @@
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/lotus/generators/application/container/capybara.rb.rspec.tt

@@ -0,0 +1,8 @@
+module RSpec
+  module FeatureExampleGroup
+    def self.included(group)
+      group.metadata[:type] = :feature
+      Capybara.app = Lotus::Container.new
+    end
+  end
+end

data/lib/lotus/generators/application/container/config/.env.development.tt

@@ -1,2 +1,2 @@
 # Define ENV variables for development environment
-<%= config[:app_name].upcase %>_DATABASE_URL="file:///db/<%= config[:app_name] %>_development"
+<%= config[:app_name].to_env_s %>_DATABASE_URL="file:///db/<%= config[:app_name] %>_development"

data/lib/lotus/generators/application/container/config/.env.test.tt

@@ -1,2 +1,2 @@
 # Define ENV variables for test environment
-<%= config[:app_name].upcase %>_DATABASE_URL="file:///db/<%= config[:app_name] %>_test"
+<%= config[:app_name].to_env_s %>_DATABASE_URL="file:///db/<%= config[:app_name] %>_test"

data/lib/lotus/generators/application/container/features_helper.rb.rspec.tt

@@ -0,0 +1,12 @@
+# Require this file for feature tests
+require_relative './spec_helper'
+
+require 'capybara'
+require 'capybara/rspec'
+
+RSpec.configure do |config|
+  config.include RSpec::FeatureExampleGroup
+
+  config.include Capybara::DSL,           feature: true
+  config.include Capybara::RSpecMatchers, feature: true
+end

data/lib/lotus/generators/application/container/lib/app_name.rb.tt

@@ -1,5 +1,5 @@
 require 'lotus/model'
-Dir["#{ __dir__ }/**/*.rb"].each { |file| require_relative file }
+Dir["#{ __dir__ }/<%= config[:app_name] %>/**/*.rb"].each { |file| require_relative file }
 
 Lotus::Model.configure do
   # Database adapter
@@ -14,11 +14,17 @@ Lotus::Model.configure do
   #    adapter type: :sql, uri: 'postgres://localhost/<%= config[:app_name] %>_development'
   #    adapter type: :sql, uri: 'mysql://localhost/<%= config[:app_name] %>_development'
   #
-  adapter type: :file_system, uri: ENV['<%= config[:app_name].upcase %>_DATABASE_URL']
+  adapter type: :file_system, uri: ENV['<%= config[:app_name].to_env_s %>_DATABASE_URL']
 
   ##
   # Database mapping
   #
+  # You can specify mapping file to load with:
+  #
+  # mapping "#{__dir__}/config/mapping"
+  #
+  # Alternatively, you can use a block syntax like the following:
+  #
   mapping do
     # collection :users do
     #   entity     User

data/lib/lotus/generators/application/container/lib/config/mapping.rb.tt

@@ -0,0 +1,7 @@
+# collection :users do
+#   entity     User
+#   repository UserRepository
+#
+#   attribute :id,   Integer
+#   attribute :name, String
+# end

data/lib/lotus/generators/application/container/rspec.rspec.tt

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/lib/lotus/generators/application/container/spec_helper.rb.rspec.tt

@@ -0,0 +1,102 @@
+# Require this file for unit tests
+ENV['LOTUS_ENV'] ||= 'test'
+
+require_relative '../config/environment'
+
+Dir[__dir__ + '/support/**/*.rb'].each { |f| require f }
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # Preload application for testing in isolation components
+  config.before(:suite) { Lotus::Application.preload! }
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end
+

data/lib/lotus/generators/application/container.rb

@@ -10,15 +10,18 @@ module Lotus
 
           @slice_generator     = Slice.new(command)
           @lotus_head          = options.fetch(:lotus_head)
+          @test                = options[:test]
           @lotus_model_version = '~> 0.2'
 
           cli.class.source_root(source)
         end
 
         def start
+
           opts      = {
             app_name:            app_name,
             lotus_head:          @lotus_head,
+            test:                @test,
             lotus_model_version: @lotus_model_version
           }
 
@@ -30,6 +33,7 @@ module Lotus
             'config/.env.development.tt' => 'config/.env.development',
             'config/.env.test.tt'        => 'config/.env.test',
             'lib/app_name.rb.tt'         => "lib/#{ app_name }.rb",
+            'lib/config/mapping.rb.tt'   => 'lib/config/mapping.rb',
           }
 
           empty_directories = [
@@ -40,19 +44,27 @@ module Lotus
 
           case options[:test]
           when 'rspec'
+            templates.merge!(
+              'Rakefile.rspec.tt'           => 'Rakefile',
+              'rspec.rspec.tt'              => '.rspec',
+              'spec_helper.rb.rspec.tt'     => 'spec/spec_helper.rb',
+              'features_helper.rb.rspec.tt' => 'spec/features_helper.rb',
+              'capybara.rb.rspec.tt'        => 'spec/support/capybara.rb'
+            )
           else # minitest (default)
             templates.merge!(
-              'Rakefile.minitest.tt'  => 'Rakefile',
-              'spec_helper.rb.tt'     => 'spec/spec_helper.rb',
-              'features_helper.rb.tt' => 'spec/features_helper.rb'
+              'Rakefile.minitest.tt'           => 'Rakefile',
+              'spec_helper.rb.minitest.tt'     => 'spec/spec_helper.rb',
+              'features_helper.rb.minitest.tt' => 'spec/features_helper.rb'
             )
-
-            empty_directories << [
-              "spec/#{ app_name }/entities",
-              "spec/#{ app_name }/repositories"
-            ]
           end
 
+          empty_directories << [
+            "spec/#{ app_name }/entities",
+            "spec/#{ app_name }/repositories",
+            "spec/support"
+          ]
+
           templates.each do |src, dst|
             cli.template(source.join(src), target.join(dst), opts)
           end

data/lib/lotus/generators/slice.rb

@@ -1,6 +1,7 @@
 require 'securerandom'
 require 'lotus/generators/abstract'
 require 'lotus/utils/string'
+require 'lotus/application_name'
 
 module Lotus
   module Generators
@@ -8,8 +9,9 @@ module Lotus
       def initialize(command)
         super
 
-        @slice_name            = options.fetch(:application)
-        @upcase_slice_name     = @slice_name.upcase
+        application_name       = ApplicationName.new(options.fetch(:application))
+        @slice_name            = application_name.to_s
+        @upcase_slice_name     = application_name.to_env_s
         @classified_slice_name = Utils::String.new(@slice_name).classify
 
         @source                = Pathname.new(::File.dirname(__FILE__) + '/../generators/slice')
@@ -44,15 +46,12 @@ module Lotus
           "public/stylesheets"
         ]
 
-        case options[:test]
-        when 'rspec'
-        else # minitest (default)
-          empty_directories << [
-            "../../spec/#{ opts[:slice_name] }/features",
-            "../../spec/#{ opts[:slice_name] }/controllers",
-            "../../spec/#{ opts[:slice_name] }/views"
-          ]
-        end
+        # Add testing directories (spec/ is the default for both MiniTest and RSpec)
+        empty_directories << [
+          "../../spec/#{ opts[:slice_name] }/features",
+          "../../spec/#{ opts[:slice_name] }/controllers",
+          "../../spec/#{ opts[:slice_name] }/views"
+        ]
 
         ##
         # config/environment.rb

data/lib/lotus/loader.rb

@@ -40,6 +40,7 @@ module Lotus
       _configure_model_framework! if defined?(Lotus::Model)
       _configure_controller_framework!
       _configure_view_framework!
+      _configure_logger!
     end
 
     def _configure_controller_framework!
@@ -87,6 +88,12 @@ module Lotus
       end
     end
 
+    def _configure_logger!
+      unless application_module.const_defined?('Logger', false)
+        logger = Lotus::Logger.new(application_module.to_s)
+        application_module.const_set('Logger', logger)
+      end
+    end
 
     def load_frameworks!
       _load_view_framework!

data/lib/lotus/logger.rb

@@ -0,0 +1,141 @@
+require 'logger'
+require 'lotus/utils/string'
+
+module Lotus
+  # Lotus logger
+  #
+  # Implement with the same interface of Ruby std lib `Logger`.
+  # It uses `STDOUT` as output device.
+  #
+  #
+  #
+  # When a Lotus application is initialized, it creates a logger for that specific application.
+  # For instance for a `Bookshelf::Application` a `Bookshelf::Logger` will be available.
+  #
+  # This is useful for auto-tagging the output. Eg (`[Booshelf]`).
+  #
+  # When used stand alone (eg. `Lotus::Logger.info`), it tags lines with `[Shared]`.
+  #
+  #
+  #
+  # The available severity levels are the same of `Logger`:
+  #
+  #   * debug
+  #   * error
+  #   * fatal
+  #   * info
+  #   * unknown
+  #   * warn
+  #
+  # Those levels are available both as class and instance methods.
+  #
+  # @since 0.2.1
+  #
+  # @see http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html
+  # @see http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger/Severity.html
+  #
+  # @example Basic usage
+  #   require 'lotus'
+  #
+  #   module Bookshelf
+  #     class Application < Lotus::Application
+  #     end
+  #   end
+  #
+  #   # Initialize the application with the following code:
+  #   Bookshelf::Application.load!
+  #   # or
+  #   Bookshelf::Application.new
+  #
+  #   Bookshelf::Logger.info('Hello')
+  #   # => I, [2015-01-10T21:55:12.727259 #80487]  INFO -- [Bookshelf] : Hello
+  #
+  #   Bookshelf::Logger.new.info('Hello')
+  #   # => I, [2015-01-10T21:55:12.727259 #80487]  INFO -- [Bookshelf] : Hello
+  #
+  # @example Standalone usage
+  #   require 'lotus'
+  #
+  #   Lotus::Logger.info('Hello')
+  #   # => I, [2015-01-10T21:55:12.727259 #80487]  INFO -- [Lotus] : Hello
+  #
+  #   Lotus::Logger.new.info('Hello')
+  #   # => I, [2015-01-10T21:55:12.727259 #80487]  INFO -- [Lotus] : Hello
+  #
+  # @example Custom tagging
+  #   require 'lotus'
+  #
+  #   Lotus::Logger.new('FOO').info('Hello')
+  #   # => I, [2015-01-10T21:55:12.727259 #80487]  INFO -- [FOO] : Hello
+  class Logger < ::Logger
+    # Lotus::Logger default formatter
+    #
+    # @since 0.2.1
+    # @api private
+    #
+    # @see http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger/Formatter.html
+    class Formatter < ::Logger::Formatter
+      # @since 0.2.1
+      # @api private
+      attr_writer :application_name
+
+      # @since 0.2.1
+      # @api private
+      #
+      # @see http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger/Formatter.html#method-i-call
+      def call(severity, time, progname, msg)
+        progname = "[#{@application_name}] #{progname}"
+        super(severity, time.utc, progname, msg)
+      end
+    end
+
+    # Default application name.
+    # This is used as a fallback for tagging purposes.
+    #
+    # @since 0.2.1
+    # @api private
+    DEFAULT_APPLICATION_NAME = 'Lotus'.freeze
+
+    # @since 0.2.1
+    # @api private
+    attr_writer :application_name
+
+    # Initialize a logger
+    #
+    # @param application_name [String] an optional application name used for
+    #   tagging purposes
+    #
+    # @since 0.2.1
+    def initialize(application_name = nil)
+      super(STDOUT)
+
+      @application_name = application_name
+      @formatter        = Lotus::Logger::Formatter.new.tap { |f| f.application_name = self.application_name }
+    end
+
+    # Returns the current application name, this is used for tagging purposes
+    #
+    # @return [String] the application name
+    #
+    # @since 0.2.1
+    def application_name
+      @application_name || _application_name_from_namespace || _default_application_name
+    end
+
+    private
+    # @since 0.2.1
+    # @api private
+    def _application_name_from_namespace
+      class_name = self.class.name
+      namespace  = Utils::String.new(class_name).namespace
+
+      class_name != namespace and return namespace
+    end
+
+    # @since 0.2.1
+    # @api private
+    def _default_application_name
+      DEFAULT_APPLICATION_NAME
+    end
+  end
+end

data/lib/lotus/rendering_policy.rb

@@ -14,13 +14,8 @@ module Lotus
 
     LOTUS_ACTION = 'lotus.action'.freeze
 
-    SUCCESSFUL_STATUSES   = (200..201).freeze
-    STATUSES_WITHOUT_BODY = Set.new((100..199).to_a << 204 << 205 << 301 << 302 << 304).freeze
-    EMPTY_BODY            = Array.new.freeze
-    RENDERABLE_FORMATS    = [:all, :html].freeze
-    CONTENT_TYPE          = 'Content-Type'.freeze
-    REQUEST_METHOD        = 'REQUEST_METHOD'.freeze
-    HEAD                  = 'HEAD'.freeze
+    SUCCESSFUL_STATUSES = (200..201).freeze
+    RENDERABLE_FORMATS  = [:all, :html].freeze
 
     def initialize(configuration)
       @controller_pattern = %r{#{ configuration.controller_pattern.gsub(/\%\{(controller|action)\}/) { "(?<#{ $1 }>(.*))" } }}
@@ -30,7 +25,7 @@ module Lotus
     end
 
     def render(env, response)
-      body = _render(env, response) || _render_head(env)
+      body = _render(env, response)
 
       response[BODY] = Array(body) unless body.nil?
       response
@@ -47,7 +42,7 @@ module Lotus
     def _render_action(action, response)
       if successful?(response)
         view_for(action, response).render(
-          action.to_rendering
+          action.exposures
         )
       end
     end
@@ -58,26 +53,16 @@ module Lotus
       end
     end
 
-    def _render_head(env)
-      EMPTY_BODY if head?(env)
-    end
-
     def renderable?(env)
-      !head?(env) and
-        env.delete(LOTUS_ACTION)
+      ((action = env.delete(LOTUS_ACTION)) && action.renderable? ) and action
     end
 
     def successful?(response)
       SUCCESSFUL_STATUSES.include?(response[STATUS])
     end
 
-    def head?(env)
-      env[REQUEST_METHOD] == HEAD
-    end
-
     def render_status_page?(action, response)
-      RENDERABLE_FORMATS.include?(action.format) &&
-        !STATUSES_WITHOUT_BODY.include?(response[STATUS])
+      RENDERABLE_FORMATS.include?(action.format)
     end
 
     def view_for(action, response)

data/lib/lotus/templates/welcome.html

@@ -43,7 +43,7 @@
       </div>
     </div>
     <div id="footer">
-      &copy; 2014 Luca Guidi &mdash; Lotus is released under the MIT License.
+      &copy; 2015 Luca Guidi &mdash; Lotus is released under the MIT License.
     </div>
   </body>
 </html>

data/lib/lotus/version.rb

@@ -2,5 +2,5 @@ module Lotus
   # Defines the version
   #
   # @since 0.1.0
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'.freeze
 end

data/lib/lotus.rb

@@ -1,6 +1,7 @@
 require 'lotus/version'
 require 'lotus/application'
 require 'lotus/container'
+require 'lotus/logger'
 
 # A complete web framework for Ruby
 #

data/lotusrb.gemspec

@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_dependency 'lotus-utils',      '~> 0.3', '>= 0.3.2'
-  spec.add_dependency 'lotus-router',     '~> 0.2'
-  spec.add_dependency 'lotus-controller', '~> 0.3'
+  spec.add_dependency 'lotus-utils',      '~> 0.3', '>= 0.3.4'
+  spec.add_dependency 'lotus-router',     '~> 0.2', '>= 0.2.1'
+  spec.add_dependency 'lotus-controller', '~> 0.3', '>= 0.3.2'
   spec.add_dependency 'lotus-view',       '~> 0.3'
   spec.add_dependency 'shotgun',          '~> 0.9'
   spec.add_dependency 'dotenv',           '~> 1.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lotusrb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-23 00:00:00.000000000 Z
+date: 2015-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lotus-utils
@@ -19,7 +19,7 @@ dependencies:
         version: '0.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: 0.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '0.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: 0.3.4
 - !ruby/object:Gem::Dependency
   name: lotus-router
   requirement: !ruby/object:Gem::Requirement
@@ -37,6 +37,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,6 +47,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: lotus-controller
   requirement: !ruby/object:Gem::Requirement
@@ -51,6 +57,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,6 +67,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.2
 - !ruby/object:Gem::Dependency
   name: lotus-view
   requirement: !ruby/object:Gem::Requirement
@@ -184,6 +196,7 @@ files:
 - bin/lotus
 - lib/lotus.rb
 - lib/lotus/application.rb
+- lib/lotus/application_name.rb
 - lib/lotus/cli.rb
 - lib/lotus/commands/console.rb
 - lib/lotus/commands/new.rb
@@ -206,29 +219,35 @@ files:
 - lib/lotus/generators/application/container/.gitkeep
 - lib/lotus/generators/application/container/Gemfile.tt
 - lib/lotus/generators/application/container/Rakefile.minitest.tt
+- lib/lotus/generators/application/container/Rakefile.rspec.tt
+- lib/lotus/generators/application/container/capybara.rb.rspec.tt
 - lib/lotus/generators/application/container/config.ru.tt
 - lib/lotus/generators/application/container/config/.env.development.tt
 - lib/lotus/generators/application/container/config/.env.test.tt
 - lib/lotus/generators/application/container/config/.env.tt
 - lib/lotus/generators/application/container/config/environment.rb.tt
 - lib/lotus/generators/application/container/db/.gitkeep
-- lib/lotus/generators/application/container/features_helper.rb.tt
+- lib/lotus/generators/application/container/features_helper.rb.minitest.tt
+- lib/lotus/generators/application/container/features_helper.rb.rspec.tt
 - lib/lotus/generators/application/container/lib/app_name.rb.tt
 - lib/lotus/generators/application/container/lib/chirp/entities/.gitkeep
 - lib/lotus/generators/application/container/lib/chirp/repositories/.gitkeep
-- lib/lotus/generators/application/container/spec_helper.rb.tt
+- lib/lotus/generators/application/container/lib/config/mapping.rb.tt
+- lib/lotus/generators/application/container/rspec.rspec.tt
+- lib/lotus/generators/application/container/spec_helper.rb.minitest.tt
+- lib/lotus/generators/application/container/spec_helper.rb.rspec.tt
 - lib/lotus/generators/slice.rb
 - lib/lotus/generators/slice/.gitkeep.tt
 - lib/lotus/generators/slice/action.rb.tt
 - lib/lotus/generators/slice/application.rb.tt
 - lib/lotus/generators/slice/config/mapping.rb.tt
 - lib/lotus/generators/slice/config/routes.rb.tt
-- lib/lotus/generators/slice/templates/application.html.erb
 - lib/lotus/generators/slice/templates/application.html.erb.tt
 - lib/lotus/generators/slice/templates/template.html.erb.tt
 - lib/lotus/generators/slice/view.rb.tt
 - lib/lotus/generators/slice/views/application_layout.rb.tt
 - lib/lotus/loader.rb
+- lib/lotus/logger.rb
 - lib/lotus/middleware.rb
 - lib/lotus/rendering_policy.rb
 - lib/lotus/routes.rb
@@ -263,7 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A complete web framework for Ruby

data/lib/lotus/generators/slice/templates/application.html.erb

@@ -1,9 +0,0 @@
-<!doctype HTML>
-<html>
-  <head>
-    <title>Chirp!</title>
-  </head>
-  <body>
-    <%= yield %>
-  </body>
-</html>