lotusrb 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b55d7a5c85223bdd933991a7dd042bc9319346c4
-  data.tar.gz: 64b71e0266d64d7ffcdf65af2f7d6309432dc673
+  metadata.gz: 7f32830cbb663112f677e1ab3a0d5f7ca80c67a7
+  data.tar.gz: 3f789bd21edc08f3ddfdbaca0fadce257c93074f
 SHA512:
-  metadata.gz: b8fbd473ccaedb272a101587f25ed494cc1a6bd43d3dbd89971baef2520293398358153dc0d5d231fe2dd8ab4f06fcf50b242990b0ae95ec48064e2cf06d52e3
-  data.tar.gz: 2365f2e8fb616a841d670adc1d29a59fc1004dc1e05fc9039ff9da52349407aecdbf245b392c9eb0bc6e8a21a061d8262f5115948540f5b34f221b7271a45955
+  metadata.gz: ede52cb5d932e0642ceeb92fab98f94f687a8f37234f23692a0ab53041039e45006824d8982025585ea1a8d16f4a437cf4b8e82f0850b293685eec10b5eefac3
+  data.tar.gz: 2bab5576e9b6e04a75bcfa118e8da82ab7c87a5c0657ef568492bf542f63cc83ce49a5221df0f171c432a1aafa946dda62943f8e028023024e653e59fe0f5730

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Lotus
 A complete web framework for Ruby
 
+## v0.3.1 - 2015-05-15
+### Added
+- [Hiếu Nguyễn] Introduced application generator (eg. `bundle exec lotus generate app admin` creates `apps/admin`).
+- [Ngọc Nguyễn] Introduced model generator (eg. `bundle exec lotus generate model user` creates entity, repository and test files).
+- [Ngọc Nguyễn] Introduced `Lotus.env`, `Lotus.env?` for current environment introspection (eg. `Lotus.env?(:test)` or `Lotus.env?(:staging, :production)`)
+- [Miguel Molina] Skip view creation when an action is generated via `--skip-view` CLI arg.
+
+### Fixed
+- [Luca Guidi] Ensure routes to be loaded for unit tests
+
 ## v0.3.0 - 2015-03-23
 ### Added
 - [Luca Guidi] Introduced action generator. Eg. `bundle exec lotus generate action web dashboard#index`

data/FEATURES.md

@@ -3,6 +3,17 @@
 
 ## Features
 
+## v0.3.1 - 2015-05-15
+
+- CLI: `lotus generate app admin` creates a new application (`apps/admin`).
+- CLI: `lotus generate model user`. It generates entity, repository and related unit test files.
+- `Lotus.env` and `Lotus.env?` for current environment introspection (eg. `Lotus.env?(:test)` or `Lotus.env?(:staging, :production)`)
+- Allow repositories to execute raw query/commands against database
+- Automatic timestamps update for entities
+– Dirty Tracking for entities (via `Lotus::Entity::DirtyTracking`)
+- Nested RESTful resource(s)
+- String pluralization and singularization
+
 ## v0.3.0 - 2015-03-23
 
 - CLI: `lotus generate action web dashboard#index`. It generates an action, a view, a template, a route and related unit test files.

data/README.md

@@ -6,13 +6,12 @@ A complete web framework for Ruby
 
 Lotus combines small yet powerful frameworks:
 
-* [**Lotus::Utils**](https://github.com/lotus/utils) - Ruby core extentions and class utilities
+* [**Lotus::Utils**](https://github.com/lotus/utils) - Ruby core extensions and class utilities
 * [**Lotus::Router**](https://github.com/lotus/router) - Rack compatible HTTP router for Ruby
 * [**Lotus::Validations**](https://github.com/lotus/validations) - Validation mixin for Ruby objects
 * [**Lotus::Helpers**](https://github.com/lotus/helpers) - View helpers for Ruby applications
 * [**Lotus::Model**](https://github.com/lotus/model) - Persistence with entities, repositories and data mapper
 * [**Lotus::View**](https://github.com/lotus/view) - Presentation with a separation between views and templates
-* [**Lotus::Helpers**](https://github.com/lotus/helpers) - Presentation helpers for views
 * [**Lotus::Controller**](https://github.com/lotus/controller) - Full featured, fast and testable actions for Rack
 
 These components are designed to be used independently or together in a Lotus application.

data/lib/lotus.rb

@@ -2,6 +2,7 @@ require 'lotus/version'
 require 'lotus/application'
 require 'lotus/container'
 require 'lotus/logger'
+require 'lotus/environment'
 
 # A complete web framework for Ruby
 #
@@ -9,4 +10,46 @@ require 'lotus/logger'
 #
 # @see http://lotusrb.org
 module Lotus
+
+  # Return the current environment
+  #
+  # @return [String] the current environment
+  #
+  # @since 0.3.1
+  #
+  # @see Lotus::Environment#environment
+  #
+  # @example
+  #   Lotus.env => "development"
+  def self.env
+    Environment.new.environment
+  end
+
+  # Check to see if specified environment(s) matches the current environment.
+  #
+  # If multiple names are given, it returns true, if at least one of them
+  # matches the current environment.
+  #
+  # @return [TrueClass,FalseClass] the result of the check
+  #
+  # @since 0.3.1
+  #
+  # @see Lotus.env
+  #
+  # @example Single name
+  #   puts ENV['LOTUS_ENV'] # => "development"
+  #
+  #   Lotus.env?(:development)  # => true
+  #   Lotus.env?('development') # => true
+  #
+  #   Lotus.env?(:production)   # => false
+  #
+  # @example Multiple names
+  #   puts ENV['LOTUS_ENV'] # => "development"
+  #
+  #   Lotus.env?(:development, :test)   # => true
+  #   Lotus.env?(:production, :staging) # => false
+  def self.env?(*names)
+    Environment.new.environment?(*names)
+  end
 end

data/lib/lotus/cli.rb

@@ -80,7 +80,9 @@ module Lotus
     end
 
     desc 'generate', 'generates a new action'
-    method_option :path,                desc: 'applications path',        type: :string, default: 'apps'
+    method_option :application_base_url, desc: 'application base url',     type: :string
+    method_option :path,                desc: 'applications path',                                         type: :string,  default: 'apps'
+    method_option :skip_view,           desc: 'skip the creation of view and templates (only for action)', type: :boolean, default: false
     method_option :help, aliases: '-h', desc: 'displays the usage method'
 
     # @since 0.3.0

data/lib/lotus/commands/generate.rb

@@ -10,6 +10,8 @@ module Lotus
       # @since 0.3.0
       # @api private
       GENERATORS_NAMESPACE = "Lotus::Generators::%s".freeze
+      APP = 'app'.freeze
+      SLICE_TYPE = 'slice'.freeze
 
       # @since 0.3.0
       # @api private
@@ -24,16 +26,15 @@ module Lotus
       # @api private
       def initialize(type, app_name, name, env, cli)
         @cli      = cli
-        @options  = env.to_options.merge(cli.options)
-
-        @app_name = app_name
-        @app      = Utils::String.new(@app_name).classify
-
         @name     = name
-        @type     = type
 
+        @type = sanitize_type(type)
+        @app_name = app_name
         @source   = Pathname.new(::File.dirname(__FILE__) + "/../generators/#{ @type }/").realpath
         @target   = Pathname.pwd.realpath
+
+        @app      = Utils::String.new(@app_name).classify
+        @options  = sanitize_app_name_options(app_name).merge(env.to_options.merge(cli.options))
       end
 
       # @since 0.3.0
@@ -57,6 +58,13 @@ module Lotus
         @spec_root ||= Pathname.new('spec')
       end
 
+      # @since 0.3.1
+      # @api private
+      def model_root
+        @model_root ||= Pathname.new(['lib', ::File.basename(Dir.getwd)]
+          .join(::File::SEPARATOR))
+      end
+
       private
       # @since 0.3.0
       # @api private
@@ -65,6 +73,21 @@ module Lotus
         class_name = Utils::String.new(@type).classify
         Utils::Class.load!(GENERATORS_NAMESPACE % class_name).new(self)
       end
+
+      # @since 0.3.1
+      # @api private
+      def sanitize_app_name_options(app_name)
+        {
+          application: app_name,
+          application_base_url: "/#{app_name}"
+        }
+      end
+
+      # @since 0.3.1
+      # @api private
+      def sanitize_type(type)
+        type == APP ? SLICE_TYPE : type
+      end
     end
   end
 end

data/lib/lotus/environment.rb

@@ -180,6 +180,13 @@ module Lotus
       @environment ||= ENV[LOTUS_ENV] || ENV[RACK_ENV] || DEFAULT_ENV
     end
 
+    # @since 0.3.1
+    #
+    # @see Lotus.env?(name)
+    def environment?(*names)
+      names.map(&:to_s).include?(environment)
+    end
+
     # A set of Bundler groups
     #
     # @return [Array] A set of groups

data/lib/lotus/generators/action.rb

@@ -48,22 +48,27 @@ module Lotus
           template_path: _template_path,
         }
 
+        test_type = case options[:test]
+                    when 'rspec'
+                      'rspec'
+                    else
+                      'minitest'
+                    end
+
         templates = {
-          'action.rb.tt' => _action_path,
-          'view.rb.tt'   => _view_path,
-          'template.tt'  => _template_path
+          "action_spec.#{test_type}.tt" => _action_spec_path,
         }
 
-        case options[:test]
-        when 'rspec'
+        if !options[:skip_view]
           templates.merge!({
-            'action_spec.rspec.tt' => _action_spec_path,
-            'view_spec.rspec.tt'   => _view_spec_path,
+            'action.rb.tt' => _action_path,
+            'view.rb.tt'   => _view_path,
+            'template.tt'  => _template_path,
+            "view_spec.#{test_type}.tt" => _view_spec_path,
           })
         else
           templates.merge!({
-            'action_spec.minitest.tt' => _action_spec_path,
-            'view_spec.minitest.tt'   => _view_spec_path,
+            'action_without_view.rb.tt' => _action_path,
           })
         end
 

data/lib/lotus/generators/action/action_without_view.rb.tt

@@ -0,0 +1,9 @@
+module <%= config[:app] %>::Controllers::<%= config[:controller] %>
+  class <%= config[:action] %>
+    include <%= config[:app] %>::Action
+
+    def call(params)
+      self.body = 'OK'
+    end
+  end
+end

data/lib/lotus/generators/model.rb

@@ -0,0 +1,77 @@
+require 'lotus/generators/abstract'
+require 'lotus/utils/string'
+
+module Lotus
+  module Generators
+    class Model < Abstract
+
+      # @since 0.3.1
+      # @api private
+      def initialize(command)
+        super
+
+        @model = app_name
+        @model_name = Utils::String.new(@model).classify
+
+        cli.class.source_root(source)
+      end
+
+      # @since 0.3.1
+      # @api private
+      def start
+        opts = {
+          model_name: @model_name
+        }
+
+        templates = {
+          'entity.rb.tt'     => _entity_path,
+          'repository.rb.tt' => _repository_path
+        }
+
+        case options[:test]
+        when 'rspec'
+          templates.merge!({
+            'entity_spec.rspec.tt'     => _entity_spec_path,
+            'repository_spec.rspec.tt' => _repository_spec_path,
+          })
+        else
+          templates.merge!({
+            'entity_spec.minitest.tt'     => _entity_spec_path,
+            'repository_spec.minitest.tt' => _repository_spec_path,
+          })
+        end
+
+        templates.each do |src, dst|
+          cli.template(source.join(src), target.join(dst), opts)
+        end
+      end
+
+      private
+      # @since 0.3.1
+      # @api private
+      def _entity_path
+        model_root.join("entities", "#{@model}.rb").to_s
+      end
+
+      # @since 0.3.1
+      # @api private
+      def _repository_path
+        model_root.join("repositories", "#{@model}_repository.rb").to_s
+      end
+
+      # @since 0.3.1
+      # @api private
+      def _entity_spec_path
+        spec_root.join(::File.basename(Dir.getwd), 'entities', "#{ @model }_spec.rb")
+      end
+
+      # @since 0.3.1
+      # @api private
+      def _repository_spec_path
+        spec_root.join(::File.basename(Dir.getwd), 'repositories',
+          "#{ @model }_repository_spec.rb")
+      end
+
+    end
+  end
+end

data/lib/lotus/generators/model/entity.rb.tt

@@ -0,0 +1,5 @@
+require 'lotus/entity'
+
+class <%= config[:model_name] %>
+  include Lotus::Entity
+end

data/lib/lotus/generators/model/entity_spec.minitest.tt

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe <%= config[:model_name] %> do
+  # place your tests here
+end

data/lib/lotus/generators/model/entity_spec.rspec.tt

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe <%= config[:model_name] %> do
+  # place your tests here
+end

data/lib/lotus/generators/model/repository.rb.tt

@@ -0,0 +1,5 @@
+require 'lotus/repository'
+
+class <%= config[:model_name] %>Repository
+  include Lotus::Repository
+end

data/lib/lotus/generators/model/repository_spec.minitest.tt

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe <%= config[:model_name] %>Repository do
+  # place your tests here
+end

data/lib/lotus/generators/model/repository_spec.rspec.tt

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe <%= config[:model_name] %>Repository do
+  # place your tests here
+end

data/lib/lotus/generators/slice.rb

@@ -58,13 +58,13 @@ module Lotus
         #
 
         # Add "require_relative '../apps/web/application'"
-        cli.gsub_file target.join('config/environment.rb'), /require_relative (.*)/ do |match|
-          match << "\nrequire_relative '../apps/#{ opts[:slice_name] }/application'"
+        cli.inject_into_file target.join('config/environment.rb'), after: /require_relative '\.\.\/lib\/(.*)'/ do
+          "\nrequire_relative '../apps/#{ opts[:slice_name] }/application'"
         end
 
         # Mount slice inside "Lotus::Container.configure"
-        cli.gsub_file target.join('config/environment.rb'), /(mount (.*)|Lotus::Container.configure do)/ do |match|
-          match << "\n  mount #{ opts[:classified_slice_name] }::Application, at: '#{ opts[:slice_base_url] }'"
+        cli.inject_into_file target.join('config/environment.rb'), after: /Lotus::Container.configure do/ do |match|
+          "\n  mount #{ opts[:classified_slice_name] }::Application, at: '#{ opts[:slice_base_url] }'"
         end
 
         ##

data/lib/lotus/generators/slice/application.rb.tt

@@ -52,8 +52,18 @@ module <%= config[:classified_slice_name] %>
       # port 443
 
       # Enable cookies
+      # Argument: boolean to toggle the feature
+      #           A Hash with options
+      #
+      # Options: :domain   - The domain (String - nil by default, not required)
+      #          :path     - Restrict cookies to a relative URI (String - nil by default)
+      #          :max_age  - Cookies expiration expressed in seconds (Integer - nil by default)
+      #          :secure   - Restrict cookies to secure connections
+      #                      (Boolean - Automatically set on true if currenlty using a secure connection)
+      #                      See #scheme and #ssl?
+      #          :httponly - Prevent JavaScript access (Boolean - true by default)
       #
-      # cookies true
+      # cookies true, {}
 
       # Enable sessions
       # Argument: Symbol the Rack session adapter

data/lib/lotus/loader.rb

@@ -138,11 +138,12 @@ module Lotus
     end
 
     def load_rack!
+      _assign_routes_to_application_module!
+
       return if application.is_a?(Class)
       _assign_rendering_policy!
       _assign_rack_routes!
       _load_rack_middleware!
-      _assign_routes_to_application_module!
     end
 
     def _assign_rendering_policy!
@@ -150,17 +151,7 @@ module Lotus
     end
 
     def _assign_rack_routes!
-      resolver    = Lotus::Routing::EndpointResolver.new(pattern: configuration.controller_pattern, namespace: namespace)
-      default_app = Lotus::Routing::Default.new
-      application.routes = Lotus::Router.new(
-        parsers:     configuration.body_parsers,
-        resolver:    resolver,
-        default_app: default_app,
-        scheme:      configuration.scheme,
-        host:        configuration.host,
-        port:        configuration.port,
-        &configuration.routes
-      )
+      application.routes = application_routes
     end
 
     def _load_rack_middleware!
@@ -169,7 +160,7 @@ module Lotus
 
     def _assign_routes_to_application_module!
       unless application_module.const_defined?('Routes')
-        routes = Lotus::Routes.new(application.routes)
+        routes = Lotus::Routes.new(application_routes)
         application_module.const_set('Routes', routes)
       end
     end
@@ -180,6 +171,20 @@ module Lotus
       )
     end
 
+    def application_routes
+      resolver    = Lotus::Routing::EndpointResolver.new(pattern: configuration.controller_pattern, namespace: namespace)
+      default_app = Lotus::Routing::Default.new
+      Lotus::Router.new(
+        parsers:     configuration.body_parsers,
+        resolver:    resolver,
+        default_app: default_app,
+        scheme:      configuration.scheme,
+        host:        configuration.host,
+        port:        configuration.port,
+        &configuration.routes
+      )
+    end
+
     def namespace
       configuration.namespace || application_module
     end

data/lib/lotus/version.rb

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

data/lotusrb.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_dependency 'lotus-utils',      '~> 0.4'
-  spec.add_dependency 'lotus-router',     '~> 0.3'
+  spec.add_dependency 'lotus-router',     '~> 0.4'
   spec.add_dependency 'lotus-controller', '~> 0.4'
   spec.add_dependency 'lotus-view',       '~> 0.4'
   spec.add_dependency 'lotus-helpers',    '~> 0.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lotusrb
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-23 00:00:00.000000000 Z
+date: 2015-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lotus-utils
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: lotus-controller
   requirement: !ruby/object:Gem::Requirement
@@ -221,6 +221,7 @@ files:
 - lib/lotus/generators/action/action.rb.tt
 - lib/lotus/generators/action/action_spec.minitest.tt
 - lib/lotus/generators/action/action_spec.rspec.tt
+- lib/lotus/generators/action/action_without_view.rb.tt
 - lib/lotus/generators/action/template.tt
 - lib/lotus/generators/action/view.rb.tt
 - lib/lotus/generators/action/view_spec.minitest.tt
@@ -248,6 +249,13 @@ files:
 - 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/model.rb
+- lib/lotus/generators/model/entity.rb.tt
+- lib/lotus/generators/model/entity_spec.minitest.tt
+- lib/lotus/generators/model/entity_spec.rspec.tt
+- lib/lotus/generators/model/repository.rb.tt
+- lib/lotus/generators/model/repository_spec.minitest.tt
+- lib/lotus/generators/model/repository_spec.rspec.tt
 - lib/lotus/generators/slice.rb
 - lib/lotus/generators/slice/.gitkeep.tt
 - lib/lotus/generators/slice/action.rb.tt