lotusrb 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 935451417df1119d39a85bc9f5a4ab0b254f5f4a
-  data.tar.gz: 35a84423b6d404016700fb068965dcc1649742db
+  metadata.gz: b7c8e5cd99a779eb8d3a481262d6af49538a457e
+  data.tar.gz: 5ea631568ee7e5fc205204e97c7d5daecaa8be5d
 SHA512:
-  metadata.gz: 804e4de1c16d7840bcf859608af64eeb68687ccc0dc64f10de35b06bf8660d9c74e6bdaebca9636ec0ecadafc928252a5d989a89548b20e5ff1cacb66da325b0
-  data.tar.gz: e2ba8789564318ad4d99d489eeed5d42b8484cf21a7124140f6bcfa57d65442ce401217e6ae68a27a425bf0db7c20d2d914c53869fad85b28803e62f0e639035
+  metadata.gz: ed2204a15910591470fbb00e31331180a2192bbf0b9b4871a6b7fb5c2cdd9a043e53ecbb2193e32531f27ed5b14229118af90a7d441a69679cb156f6a5f2b0ab
+  data.tar.gz: e89361b9895b13d112f743e11ee83889be44561a6159429a24b9eb85c0297c20e9f8ed6e1ea386249776f094a6373417df5d7350e67351650a65f52022794523

data/CHANGELOG.md

@@ -1,6 +1,24 @@
 # Lotus
 A complete web framework for Ruby
 
+## v0.5.0 - 2015-09-30
+### Added
+- [Ines Coelho & Rosa Faria] Mailers
+- [Theo Felippe] Added configuration entries: `#default_request_format` and `default_response_format`
+- [Rodrigo Panachi] Introduced `logger` configuration for applications, to be used like this: `Web::Logger.debug`
+- [Ben Lovell] Simpler and less verbose RSpec tests
+- [Pascal Betz] Introduced `--method` CLI argument for action generator as a way to specify the HTTP verb
+
+### Fixed
+- [Luca Guidi] Handle conflicts between directories with the same name while serving static assets
+- [Derk-Jan Karrenbeld] Include default value `font-src: self` for CSP HTTP header
+- [Cam Huynh] Make CLI arguments immutable for `Lotus::Environment`
+- [Andrii Ponomarov] Disable welcome page in test environment
+- [Alfonso Uceda Pompa] Print error message and exit when no name is provided to model generator
+
+### Changed
+- [Theo Felippe] Deprecated `#default_format` in favor of: `#default_request_format`
+
 ## v0.4.1 - 2015-07-10
 ### Added
 - [Trung Lê] Alias `--database` as `--db` for `lotus new`

data/FEATURES.md

@@ -3,6 +3,13 @@
 
 ## Features
 
+## v0.5.0 - 2015-09-30
+
+- Mailers
+- CLI: `lotus generate mailer`
+- SQL joins
+- Custom coercers for data mapper
+
 ## v0.4.1 - 2015-07-10
 
 ## v0.4.0 - 2015-06-23

data/README.md

@@ -8,8 +8,9 @@ Lotus combines small yet powerful frameworks:
 
 * [**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::Validations**](https://github.com/lotus/validations) - Validations mixin for Ruby objects
 * [**Lotus::Helpers**](https://github.com/lotus/helpers) - View helpers for Ruby applications
+* [**Lotus::Mailer**](https://github.com/lotus/mailer) - Mail 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::Controller**](https://github.com/lotus/controller) - Full featured, fast and testable actions for Rack

data/lib/lotus/cli.rb

@@ -79,10 +79,11 @@ module Lotus
       end
     end
 
-    desc 'generate', 'generates app, action, model or migration'
+    desc 'generate', 'generates app, action, model, mailer or migration'
     method_option :application_base_url, desc: 'application base url',                                      type: :string
     method_option :path,                 desc: 'applications path',                                         type: :string
     method_option :url,                  desc: 'relative URL for action',                                   type: :string
+    method_option :method,               desc: "HTTP method for action. Upper/lower case is ignored. Must be one of GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS, TRACE.", type: :string, default: 'GET'
     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'
 

data/lib/lotus/commands/generate.rb

@@ -70,6 +70,10 @@ module Lotus
           .join(::File::SEPARATOR))
       end
 
+      # @since 0.5.0
+      # @api private
+      alias_method :core_root, :model_root
+
       private
       # @since 0.3.0
       # @api private

data/lib/lotus/config/assets.rb

@@ -7,23 +7,60 @@ module Lotus
     class Assets  < Utils::LoadPaths
       DEFAULT_DIRECTORY = 'public'.freeze
 
+      # Assets source (directory)
+      #
+      # @since 0.5.0
+      # @api private
+      class Source
+        # @since 0.5.0
+        # @api private
+        BLANK         = ''.freeze
+
+        # @since 0.5.0
+        # @api private
+        URL_SEPARATOR = '/'.freeze
+
+        # @since 0.5.0
+        # @api private
+        attr_reader :urls
+
+        # @since 0.5.0
+        # @api private
+        attr_reader :root
+
+        # @since 0.5.0
+        # @api private
+        def initialize(path)
+          @path = path.to_s
+          @root = @path.sub("#{ Lotus.root }/", BLANK)
+          @urls = {}
+
+          Dir.glob("#{ path }/**/*").each do |file|
+            next if ::File.directory?(file)
+
+            @urls.store(
+              file.sub(@path, BLANK).sub(::File::SEPARATOR, URL_SEPARATOR),
+              file.sub("#{ @path }/", BLANK)
+            )
+          end
+
+          @urls.freeze
+        end
+      end
+
       # @since 0.1.0
       # @api private
       def initialize(root)
-        @root = root
+        @root  = root
         @paths = Array(DEFAULT_DIRECTORY)
       end
 
-      # @since 0.1.0
+      # @since 0.5.0
       # @api private
-      def entries
-        hash = Hash.new { |k, v| k[v] = [] }
+      def for_each_source
         each do |path|
-          if path.exist?
-            hash[path.to_s] = path.children.map { |child| "/#{ child.basename }" }
-          end
+          yield Source.new(path) if path.exist?
         end
-        hash
       end
 
       # @since 0.2.0
@@ -41,3 +78,4 @@ module Lotus
     end
   end
 end
+

data/lib/lotus/configuration.rb

@@ -1,4 +1,5 @@
 require 'lotus/utils/kernel'
+require 'lotus/utils/deprecation'
 require 'lotus/environment'
 require 'lotus/config/framework_configuration'
 require 'lotus/config/load_paths'
@@ -958,18 +959,18 @@ module Lotus
     # an argument, it will set the corresponding instance variable. When
     # called without, it will return the already set value, or the default.
     #
-    # @overload default_format(format)
+    # @overload default_request_format(format)
     #   Sets the given value
     #   @param format [#to_sym] the symbol format
     #   @raise [TypeError] if it cannot be coerced to a symbol
     #
-    # @overload default_format
+    # @overload default_request_format
     #   Gets the value
     #   @return [Symbol]
     #
-    # @since 0.1.0
+    # @since 0.5.0
     #
-    # @see http://rdoc.info/gems/lotus-controller/Lotus/Controller/Configuration#default_format
+    # @see http://rdoc.info/gems/lotus-controller/Lotus/Controller/Configuration#default_request_format
     #
     # @example Getting the value
     #   require 'lotus'
@@ -979,7 +980,7 @@ module Lotus
     #     end
     #   end
     #
-    #   Bookshelf::Application.configuration.default_format # => :html
+    #   Bookshelf::Application.configuration.default_request_format # => :html
     #
     # @example Setting the value
     #   require 'lotus'
@@ -987,20 +988,86 @@ module Lotus
     #   module Bookshelf
     #     class Application < Lotus::Application
     #       configure do
-    #         default_format :json
+    #         default_request_format :json
     #       end
     #     end
     #   end
     #
-    #   Bookshelf::Application.configuration.default_format # => :json
-    def default_format(format = nil)
+    #   Bookshelf::Application.configuration.default_request_format # => :json
+    def default_request_format(format = nil)
       if format
-        @default_format = Utils::Kernel.Symbol(format)
+        @default_request_format = Utils::Kernel.Symbol(format)
       else
-        @default_format || :html
+        @default_request_format || :html
       end
     end
 
+    # Set a format to be used for all responses regardless of the request type.
+    #
+    # The given format must be coercible to a symbol, and be a valid mime type
+    # alias. If it isn't, at the runtime the framework will raise a
+    # `Lotus::Controller::UnknownFormatError`.
+    #
+    # By default this value is `:html`.
+    #
+    # This is part of a DSL, for this reason when this method is called with
+    # an argument, it will set the corresponding instance variable. When
+    # called without, it will return the already set value, or the default.
+    #
+    # @overload default_response_format(format)
+    #   Sets the given value
+    #   @param format [#to_sym] the symbol format
+    #   @raise [TypeError] if it cannot be coerced to a symbol
+    #
+    # @overload default_response_format
+    #   Gets the value
+    #   @return [Symbol,nil]
+    #
+    # @since 0.5.0
+    #
+    # @see http://rdoc.info/gems/lotus-controller/Lotus/Controller/Configuration#default_response_format
+    #
+    # @example Getting the value
+    #   require 'lotus'
+    #
+    #   module Bookshelf
+    #     class Application < Lotus::Application
+    #     end
+    #   end
+    #
+    #   Bookshelf::Application.configuration.default_response_format # => :html
+    #
+    # @example Setting the value
+    #   require 'lotus'
+    #
+    #   module Bookshelf
+    #     class Application < Lotus::Application
+    #       configure do
+    #         default_response_format :json
+    #       end
+    #     end
+    #   end
+    #
+    #   Bookshelf::Application.configuration.default_response_format # => :json
+    def default_response_format(format = nil)
+      if format
+        @default_response_format = Utils::Kernel.Symbol(format)
+      else
+        @default_response_format
+      end
+    end
+
+    # Set a format as default fallback for all the requests without a strict
+    # requirement for the mime type.
+    #
+    # @since 0.1.0
+    #
+    # @deprecated Use {#default_request_format} instead.
+    def default_format(format = nil)
+      Lotus::Utils::Deprecation.new('default_format is deprecated, please use default_request_format')
+      default_request_format(format)
+    end
+
     # The URI scheme for this application.
     # This is used by the router helpers to generate absolute URLs.
     #
@@ -1577,7 +1644,7 @@ module Lotus
     #   module Bookshelf
     #     class Application < Lotus::Application
     #       configure do
-    #         controller.default_format :json
+    #         controller.default_request_format :json
     #       end
     #     end
     #   end
@@ -1642,6 +1709,46 @@ module Lotus
       @view ||= Config::FrameworkConfiguration.new
     end
 
+    # Defines a logger instance to the configuration
+    #
+    # This logger instance will be used to set the logger available on application module
+    #
+    # If no logger instance is defined, a Lotus::Logger will be set by default
+    #
+    # @return [Logger, NilClass] logger instance
+    #
+    # @since 0.5.0
+    #
+    # @example Define a logger
+    #   require 'lotus'
+    #
+    #   module Bookshelf
+    #     class Application < Lotus::Application
+    #       configure do
+    #         logger Logger.new(STDOUT)
+    #       end
+    #       load!
+    #     end
+    #
+    #     module Controllers::Error
+    #       include Bookshelf::Controller
+    #
+    #       action 'Index' do
+    #         def call(params)
+    #           Bookshelf::Logger.info "Logging to STDOUT"
+    #         end
+    #       end
+    #     end
+    #   end
+    #
+    def logger(value = nil)
+      if value.nil?
+        @logger
+      else
+        @logger = value
+      end
+    end
+
     # This options is used as a bridge between container and router application.
     #
     # @return [String, NilClass] path prefix for routes
@@ -1657,6 +1764,7 @@ module Lotus
     end
 
     private
+
     # @since 0.2.0
     # @api private
     def evaluate_configurations!

data/lib/lotus/environment.rb

@@ -174,7 +174,7 @@ module Lotus
     #   # other settings (eg `XYZ`) will be left untouched.
     def initialize(options = {})
       @options = Lotus::Lotusrc.new(root, options).read
-      @options.merge! Utils::Hash.new(options).symbolize!
+      @options.merge! Utils::Hash.new(options.clone).symbolize!
       @mutex   = Mutex.new
       @mutex.synchronize { set_env_vars! }
     end

data/lib/lotus/frameworks.rb

@@ -3,6 +3,8 @@ require 'lotus/view'
 require 'lotus/controller'
 require 'lotus/action/glue'
 require 'lotus/action/csrf_protection'
+require 'lotus/mailer'
+require 'lotus/mailer/glue'
 
 Lotus::Controller.configure do
   prepare do

data/lib/lotus/generators/action.rb

@@ -1,5 +1,6 @@
 require 'lotus/generators/abstract'
 require 'lotus/utils/string'
+require 'lotus/routing/route'
 
 module Lotus
   module Generators
@@ -30,6 +31,11 @@ module Lotus
       # @api private
       DEFAULT_TEMPLATE = 'erb'.freeze
 
+      # Default HTTP method used when generating an action.
+      # @since 0.5.0
+      # @api private
+      DEFAULT_HTTP_METHOD = 'GET'.freeze
+
       # @since 0.3.0
       # @api private
       def initialize(command)
@@ -48,6 +54,7 @@ module Lotus
       def start
         assert_existing_app!
         assert_action!
+        assert_http_method!
 
         opts = {
           app:                  app,
@@ -108,6 +115,14 @@ module Lotus
         end
       end
 
+      # @since 0.5.0
+      # @api private
+      def assert_http_method!
+        if !Lotus::Routing::Route::VALID_HTTP_VERBS.include?(_http_method.upcase)
+          raise Lotus::Commands::Generate::Error.new("Unknown HTTP method '#{_http_method}', please use one of #{Lotus::Routing::Route::VALID_HTTP_VERBS.join(', ')}.")
+        end
+      end
+
       def app
         if env.container?
           super
@@ -127,10 +142,16 @@ module Lotus
 
         # Insert at the top of the file
         cli.insert_into_file _routes_path, before: /\A(.*)/ do
-          "get '#{ _route_url }', to: '#{ _route_endpoint }'\n"
+          "#{ _http_method } '#{ _route_url }', to: '#{ _route_endpoint }'\n"
         end
       end
 
+      # @since 0.5.0
+      # @api private
+      def _http_method
+        options.fetch(:method, DEFAULT_HTTP_METHOD).downcase
+      end
+
       # @since 0.4.0
       # @api private
       def _route_url

data/lib/lotus/generators/action/action_spec.rspec.tt

@@ -1,11 +1,10 @@
-require 'spec_helper'
 require_relative '<%= config[:relative_action_path] %>'
 
 describe <%= config[:app] %>::Controllers::<%= config[:controller] %>::<%= config[:action] %> do
-  let(:action) { <%= config[:app] %>::Controllers::<%= config[:controller] %>::<%= config[:action] %>.new }
+  let(:action) { described_class.new }
   let(:params) { Hash[] }
 
-  it "is successful" do
+  it 'is successful' do
     response = action.call(params)
     expect(response[0]).to eq 200
   end