lotusrb 0.1.0 → 0.2.0

data/lib/lotus/container.rb

@@ -0,0 +1,30 @@
+require 'thread'
+require 'lotus/router'
+
+module Lotus
+  class Container
+    attr_reader :routes
+
+    def self.configure(&blk)
+      Mutex.new.synchronize { @@configuration = blk }
+    end
+
+    def initialize
+      Mutex.new.synchronize do
+        assert_configuration_presence!
+        @routes = Lotus::Router.new(&@@configuration)
+      end
+    end
+
+    def call(env)
+      @routes.call(env)
+    end
+
+    private
+    def assert_configuration_presence!
+      unless self.class.class_variable_defined?(:@@configuration)
+        raise ArgumentError.new("#{ self.class } doesn't have any application mounted.")
+      end
+    end
+  end
+end

data/lib/lotus/environment.rb

@@ -0,0 +1,377 @@
+require 'thread'
+require 'pathname'
+require 'dotenv'
+require 'lotus/utils/hash'
+
+module Lotus
+  # Define and expose information about the Lotus environment.
+  #
+  # @since 0.1.0
+  # @api private
+  class Environment
+    # Standard Rack ENV key
+    #
+    # @since 0.1.0
+    # @api private
+    RACK_ENV       = 'RACK_ENV'.freeze
+
+    # Standard Lotus ENV key
+    #
+    # @since 0.1.0
+    # @api private
+    LOTUS_ENV      = 'LOTUS_ENV'.freeze
+
+    # Default Lotus environment
+    #
+    # @since 0.1.0
+    # @api private
+    DEFAULT_ENV    = 'development'.freeze
+
+    # Default `.env` file name
+    #
+    # @since 0.2.0
+    # @api private
+    DEFAULT_DOTENV = '.env'.freeze
+
+    # Default `.env` per environment file name
+    #
+    # @since 0.2.0
+    # @api private
+    DEFAULT_DOTENV_ENV = '.env.%s'.freeze
+
+    # Default configuration directory under application root
+    #
+    # @since 0.2.0
+    # @api private
+    DEFAULT_CONFIG = 'config'.freeze
+
+    # Standard Lotus host ENV key
+    #
+    # @since 0.1.0
+    # @api private
+    LOTUS_HOST      = 'LOTUS_HOST'.freeze
+
+    # Default HTTP host
+    #
+    # @since 0.1.0
+    # @api private
+    DEFAULT_HOST    = 'localhost'.freeze
+
+    # Default IP address listen
+    #
+    # @since 0.1.0
+    # @api private
+    LISTEN_ALL_HOST = '0.0.0.0'.freeze
+
+    # Standard Lotus port ENV key
+    #
+    # @since 0.1.0
+    # @api private
+    LOTUS_PORT   = 'LOTUS_PORT'.freeze
+
+    # Default Lotus HTTP port
+    #
+    # @since 0.1.0
+    # @api private
+    DEFAULT_PORT = 2300
+
+    # Default Rack configuration file
+    #
+    # @since 0.2.0
+    # @api private
+    DEFAULT_RACKUP       = 'config.ru'.freeze
+
+    # Default environment configuration file
+    #
+    # @since 0.2.0
+    # @api private
+    DEFAULT_ENVIRONMENT_CONFIG = 'environment'.freeze
+
+    # Code reloading per environment
+    #
+    # @since 0.2.0
+    # @api private
+    CODE_RELOADING = { 'development' => true }.freeze
+
+    # Initialize a Lotus environment
+    #
+    # It accepts an optional set of configurations from the CLI commands.
+    # Those settings override the defaults defined by this object.
+    #
+    # When initialized, it sets standard `ENV` variables for Rack and Lotus,
+    # such as `RACK_ENV` and `LOTUS_ENV`.
+    #
+    # It also evaluates configuration from `.env` and `.env.<environment>`
+    # located under the config directory. All the settings in those files will
+    # be exported as `ENV` variables.
+    #
+    # The format of those `.env` files is compatible with `dotenv` and `foreman`
+    # gems.
+    #
+    # @param options [Hash] override default options for various environment
+    #   attributes
+    #
+    # @return [Lotus::Environment] the environment
+    #
+    # @see Lotus::Commands::Console
+    # @see Lotus::Commands::Routes
+    # @see Lotus::Commands::Server
+    # @see Lotus::Environment#config
+    #
+    # @example Define ENV variables from .env
+    #
+    #   # % tree config/
+    #   #   config
+    #   #   ├── .env
+    #   #   ├── .env.development
+    #   #   └── environment.rb
+    #
+    #   # % cat config/.env
+    #   #   FOO="bar"
+    #   #   XYZ="yes"
+    #
+    #   # % cat config/.env.development
+    #   #   FOO="ok"
+    #
+    #   require 'lotus/environment'
+    #
+    #   env = Lotus::Environment.new
+    #   env.environment   # => "development"
+    #
+    #   # Framework defined ENV vars
+    #   ENV['LOTUS_ENV']  # => "development"
+    #   ENV['RACK_ENV']   # => "development"
+    #
+    #   ENV['LOTUS_HOST'] # => "localhost"
+    #   ENV['LOTUS_PORT'] # => "2300"
+    #
+    #   # User defined ENV vars
+    #   ENV['FOO']        # => "ok"
+    #   ENV['XYZ']        # => "yes"
+    #
+    #   # Lotus::Environment evaluates `.env` first as master configuration.
+    #   # Then it evaluates `.env.development` because the current environment
+    #   # is "development". The settings defined in this last file override
+    #   # the one defined in the parent (eg `FOO` is overwritten). All the
+    #   # other settings (eg `XYZ`) will be left untouched.
+    def initialize(options = {})
+      @options = Utils::Hash.new(options).symbolize!.freeze
+      @mutex   = Mutex.new
+      @mutex.synchronize { set_env_vars! }
+    end
+
+    # The current environment
+    #
+    # In order to decide the value, it looks up to the following `ENV` vars:
+    #
+    #   * LOTUS_ENV
+    #   * RACK_ENV
+    #
+    # If those are missing it falls back to the defalt one: `"development"`.
+    #
+    # @return [String] the current environment
+    #
+    # @since 0.1.0
+    #
+    # @see Lotus::Environment::DEFAULT_ENV
+    def environment
+      @environment ||= ENV[LOTUS_ENV] || ENV[RACK_ENV] || DEFAULT_ENV
+    end
+
+    # A set of Bundler groups
+    #
+    # @return [Array] A set of groups
+    #
+    # @since 0.2.0
+    # @api private
+    #
+    # @see http://bundler.io/v1.7/groups.html
+    def bundler_groups
+      [environment]
+    end
+
+    # Application's root
+    #
+    # It defaults to the current working directory.
+    # Lotus assumes that all the commands are executed from there.
+    #
+    # @return [Pathname] application's root
+    #
+    # @since 0.2.0
+    def root
+      @root ||= Pathname.new(Dir.pwd)
+    end
+
+    # Application's config directory
+    #
+    # It's the application where all the configurations are stored.
+    #
+    # In order to decide the value, it looks up the following sources:
+    #
+    #   * CLI option `config`
+    #
+    # If those are missing it falls back to the default one: `"config/"`.
+    #
+    # When a relative path is given via CLI option, it assumes to be located
+    # under application's root. If absolute path, it will be used as it is.
+    #
+    # @return [Pathname] the config directory
+    #
+    # @since 0.2.0
+    #
+    # @see Lotus::Environment::DEFAULT_CONFIG
+    # @see Lotus::Environment#root
+    def config
+      @config ||= root.join(@options.fetch(:config) { DEFAULT_CONFIG })
+    end
+
+    # The HTTP host name
+    #
+    # In order to decide the value, it looks up the following sources:
+    #
+    #   * CLI option `host`
+    #   * LOTUS_HOST ENV var
+    #
+    # If those are missing it falls back to the following defaults:
+    #
+    #   * `"localhost"` for development
+    #   * `"0.0.0.0"` for all the other environments
+    #
+    # @return [String] the HTTP host name
+    #
+    # @since 0.1.0
+    #
+    # @see Lotus::Environment::DEFAULT_HOST
+    # @see Lotus::Environment::LISTEN_ALL_HOST
+    def host
+      @host ||= @options.fetch(:host) {
+        ENV[LOTUS_HOST] || default_host
+      }
+    end
+
+    # The HTTP port
+    #
+    # In order to decide the value, it looks up the following sources:
+    #
+    #   * CLI option `port`
+    #   * LOTUS_PORT ENV var
+    #
+    # If those are missing it falls back to the default one: `2300`.
+    #
+    # @return [Integer] the default port
+    #
+    # @since 0.1.0
+    #
+    # @see Lotus::Environment::DEFAULT_PORT
+    def port
+      @port ||= @options.fetch(:port) { ENV[LOTUS_PORT] || DEFAULT_PORT }.to_i
+    end
+
+    # Path to the Rack configuration file
+    #
+    # In order to decide the value, it looks up the following sources:
+    #
+    #   * CLI option `rackup`
+    #
+    # If those are missing it falls back to the default one: `"config.ru"`.
+    #
+    # When a relative path is given via CLI option, it assumes to be located
+    # under application's root. If absolute path, it will be used as it is.
+    #
+    # @return [Pathname] path to the Rack configuration file
+    #
+    # @since 0.2.0
+    def rackup
+      root.join(@options.fetch(:rackup) { DEFAULT_RACKUP })
+    end
+
+    # Path to environment configuration file.
+    #
+    # In order to decide the value, it looks up the following sources:
+    #
+    #   * CLI option `environment`
+    #
+    # If those are missing it falls back to the default one:
+    # `"config/environment.rb"`.
+    #
+    # When a relative path is given via CLI option, it assumes to be located
+    # under application's root. If absolute path, it will be used as it is.
+    #
+    # @return [Pathname] path to applications
+    #
+    # @since 0.1.0
+    #
+    # @see Lotus::Environment::DEFAULT_ENVIRONMENT_CONFIG
+    def env_config
+      root.join(@options.fetch(:environment) { config.join(DEFAULT_ENVIRONMENT_CONFIG) })
+    end
+
+    # Determine if activate code reloading for the current environment while
+    # running the server.
+    #
+    # In order to decide the value, it looks up the following sources:
+    #
+    #   * CLI option `code_reloading`
+    #
+    # If those are missing it falls back to the following defaults:
+    #
+    #   * true for development
+    #   * false for all the other environments
+    #
+    # @return [TrueClass,FalseClass] the result of the check
+    #
+    # @since 0.2.0
+    #
+    # @see Lotus::Commands::Server
+    # @see Lotus::Environment::CODE_RELOADING
+    def code_reloading?
+      @options.fetch(:code_reloading) { !!CODE_RELOADING[environment] }
+    end
+
+    # Serialize the most relevant settings into a Hash
+    #
+    # @return [Lotus::Utils::Hash]
+    #
+    # @since 0.1.0
+    # @api private
+    def to_options
+      @options.merge(
+        environment: environment,
+        env_config:  env_config,
+        rackup:      rackup,
+        host:        host,
+        port:        port
+      )
+    end
+
+    private
+
+    # @since 0.1.0
+    # @api private
+    def set_env_vars!
+      set_lotus_env_vars!
+      set_application_env_vars!
+    end
+
+    # @since 0.2.0
+    # @api private
+    def set_lotus_env_vars!
+      ENV[LOTUS_ENV]  = ENV[RACK_ENV] = environment
+      ENV[LOTUS_HOST] = host
+      ENV[LOTUS_PORT] = port.to_s
+    end
+
+    # @since 0.2.0
+    # @api private
+    def set_application_env_vars!
+      Dotenv.load     config.join(DEFAULT_DOTENV)
+      Dotenv.overload config.join(DEFAULT_DOTENV_ENV % environment)
+    end
+
+    # @since 0.1.0
+    # @api private
+    def default_host
+      environment == DEFAULT_ENV ? DEFAULT_HOST : LISTEN_ALL_HOST
+    end
+  end
+end

data/lib/lotus/frameworks.rb

@@ -1,38 +1,27 @@
 require 'lotus/router'
-require 'lotus/controller'
 require 'lotus/view'
+require 'lotus/controller'
 
-# FIXME Ideally, this should be done like this:
-#
-# module Lotus
-#   module Frameworks
-#     module Action
-#       module Rack
-#         protected
-#         def response
-#           [super, self].flatten
-#         end
-#       end
-#     end
-#   end
-# end
-#
-# Lotus::Action::Rack.class_eval do
-#   include Lotus::Frameworks::Action::Rack
-# end
-#
-# ..but it doesn't work and I want to ship it!
-
-Lotus::Action::Rack.class_eval do
-  DEFAULT_RESPONSE_CODE = 200
-  DEFAULT_RESPONSE_BODY = []
+module Lotus
+  module Frameworks
+    module Action
+      module Rack
+        ENV_KEY = 'lotus.action'.freeze
 
-  protected
-  def response
-    [ @_status || DEFAULT_RESPONSE_CODE, headers, @_body || DEFAULT_RESPONSE_BODY.dup, self ]
+        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)

data/lib/lotus/generators/abstract.rb

@@ -0,0 +1,31 @@
+require 'delegate'
+
+module Lotus
+  module Generators
+    # Abstract super class for generators
+    #
+    # @abstract
+    # @since 0.2.0
+    class Abstract < SimpleDelegator
+      # Initialize a generator
+      #
+      # @param command [Thor] a Thor instance that comes from Lotus::Cli
+      #
+      # @since 0.2.0
+      # @api private
+      def initialize(command)
+        super(command)
+      end
+
+      # Start the generator
+      #
+      # @raise [NotImplementedError]
+      #
+      # @abstract
+      # @since 0.2.0
+      def start
+        raise NotImplementedError
+      end
+    end
+  end
+end

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

@@ -0,0 +1 @@
+#

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

@@ -0,0 +1,29 @@
+source 'https://rubygems.org'
+
+gem 'bundler'
+gem 'rake'
+
+<%- if config[:lotus_head] -%>
+gem 'lotus-utils',       require: false, github: 'lotus/utils'
+gem 'lotus-router',      require: false, github: 'lotus/router'
+gem 'lotus-validations', require: false, github: 'lotus/validations'
+gem 'lotus-controller',  require: false, github: 'lotus/controller'
+gem 'lotus-view',        require: false, github: 'lotus/view'
+gem 'lotus-model',       require: false, github: 'lotus/model'
+gem 'lotusrb',                           github: 'lotus/lotus'
+<%- else -%>
+gem 'lotusrb',      '<%= Lotus::VERSION %>'
+gem 'lotus-model', '<%= config[:lotus_model_version] %>'
+<%- end -%>
+
+group :test do
+<%- if config[:test] == 'rspec' -%>
+<%- else -%>
+  gem 'minitest'
+<%- end -%>
+  gem 'capybara'
+end
+
+group :production do
+  # gem 'puma'
+end

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

@@ -0,0 +1,10 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.libs    << 'spec'
+end
+
+task default: :test
+task spec: :test

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

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

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

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

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

@@ -0,0 +1 @@
+# Define ENV variables

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

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'lotus/setup'
+require_relative '../lib/<%= config[:app_name] %>'
+
+Lotus::Container.configure do
+end

data/lib/lotus/generators/application/container/config.ru.tt

@@ -0,0 +1,3 @@
+require './config/environment'
+
+run Lotus::Container.new

data/lib/lotus/generators/application/container/db/.gitkeep

@@ -0,0 +1 @@
+#

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

@@ -0,0 +1,11 @@
+# Require this file for feature tests
+require_relative './spec_helper'
+
+require 'capybara'
+require 'capybara/dsl'
+
+Capybara.app = Lotus::Container.new
+
+class MiniTest::Spec
+  include Capybara::DSL
+end

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

@@ -0,0 +1,31 @@
+require 'lotus/model'
+Dir["#{ __dir__ }/**/*.rb"].each { |file| require_relative file }
+
+Lotus::Model.configure do
+  # Database adapter
+  #
+  # Available options:
+  #
+  #  * Memory adapter
+  #    adapter type: :memory, uri: 'memory://localhost/<%= config[:app_name] %>_development'
+  #
+  #  * SQL adapter
+  #    adapter type: :sql, uri: 'sqlite://db/<%= config[:app_name] %>_development.db'
+  #    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']
+
+  ##
+  # Database mapping
+  #
+  mapping do
+    # collection :users do
+    #   entity     User
+    #   repository UserRepository
+    #
+    #   attribute :id,   Integer
+    #   attribute :name, String
+    # end
+  end
+end.load!

data/lib/lotus/generators/application/container/lib/chirp/entities/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/lotus/generators/application/container/lib/chirp/repositories/.gitkeep

@@ -0,0 +1 @@
+#

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

@@ -0,0 +1,7 @@
+# Require this file for unit tests
+ENV['LOTUS_ENV'] ||= 'test'
+
+require_relative '../config/environment'
+require 'minitest/autorun'
+
+Lotus::Application.preload!

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

@@ -0,0 +1,70 @@
+require 'lotus/generators/abstract'
+require 'lotus/generators/slice'
+
+module Lotus
+  module Generators
+    module Application
+      class Container < Abstract
+        def initialize(command)
+          super
+
+          @slice_generator     = Slice.new(command)
+          @lotus_head          = options.fetch(:lotus_head)
+          @lotus_model_version = '~> 0.2'
+
+          cli.class.source_root(source)
+        end
+
+        def start
+          opts      = {
+            app_name:            app_name,
+            lotus_head:          @lotus_head,
+            lotus_model_version: @lotus_model_version
+          }
+
+          templates = {
+            'Gemfile.tt'                 => 'Gemfile',
+            'config.ru.tt'               => 'config.ru',
+            'config/environment.rb.tt'   => 'config/environment.rb',
+            'config/.env.tt'             => 'config/.env',
+            'config/.env.development.tt' => 'config/.env.development',
+            'config/.env.test.tt'        => 'config/.env.test',
+            'lib/app_name.rb.tt'         => "lib/#{ app_name }.rb",
+          }
+
+          empty_directories = [
+            "db",
+            "lib/#{ app_name }/entities",
+            "lib/#{ app_name }/repositories"
+          ]
+
+          case options[:test]
+          when 'rspec'
+          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'
+            )
+
+            empty_directories << [
+              "spec/#{ app_name }/entities",
+              "spec/#{ app_name }/repositories"
+            ]
+          end
+
+          templates.each do |src, dst|
+            cli.template(source.join(src), target.join(dst), opts)
+          end
+
+          empty_directories.flatten.each do |dir|
+            gitkeep = '.gitkeep'
+            cli.template(source.join(gitkeep), target.join(dir, gitkeep), opts)
+          end
+
+          @slice_generator.start
+        end
+      end
+    end
+  end
+end