lotusrb 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f32830cbb663112f677e1ab3a0d5f7ca80c67a7
-  data.tar.gz: 3f789bd21edc08f3ddfdbaca0fadce257c93074f
+  metadata.gz: edf2469e81abaa0dfcfc75b88937f2cda3603a08
+  data.tar.gz: d065bb93dde49134fa3e44a21b845cd94db37522
 SHA512:
-  metadata.gz: ede52cb5d932e0642ceeb92fab98f94f687a8f37234f23692a0ab53041039e45006824d8982025585ea1a8d16f4a437cf4b8e82f0850b293685eec10b5eefac3
-  data.tar.gz: 2bab5576e9b6e04a75bcfa118e8da82ab7c87a5c0657ef568492bf542f63cc83ce49a5221df0f171c432a1aafa946dda62943f8e028023024e653e59fe0f5730
+  metadata.gz: 5624055463ef2a3413cc8e0e04cb7aec47a040f709ad733b0d7b5a81162b2c4738fc6f0cdbc3a47d9154578b72e119702cfcc001769eeb650b6c5cbbc5cc0a1e
+  data.tar.gz: 4d980f03c4f83489e083c0a0a1bfc5ad92ebd1d6a3ef89af710f5f00e0c1522d523608ab2a977e73c33ecec881380f1c5ca6e56544b5e0e39fa27d49dc0911fb

data/CHANGELOG.md

@@ -1,6 +1,19 @@
 # Lotus
 A complete web framework for Ruby
 
+## v0.3.2 - 2015-05-22
+### Added
+- [Alfonso Uceda Pompa] Automatic secure cookies if the current connection is using HTTPS.
+- [Alfonso Uceda Pompa] Routing helpers for actions (via `#routes`).
+- [My Mai] Introduced `Lotus.root`. It returns the top level directory of the project.
+
+### Fixed
+- [Ngọc Nguyễn] Model generator should use new RSpec syntax.
+- [Ngọc Nguyễn] Model generator must respect file name conventions for Ruby.
+- [Ngọc Nguyễn] Action generator must respect file name conventions for Ruby.
+- [Alfonso Uceda Pompa] Action generator must raise error if name isn't provided.
+- [Luca Guidi] Container generator for RSpec let the application to be preloaded (discard `config.before(:suite)`)
+
 ## v0.3.1 - 2015-05-15
 ### Added
 - [Hiếu Nguyễn] Introduced application generator (eg. `bundle exec lotus generate app admin` creates `apps/admin`).

data/lib/lotus/action/routing_helpers.rb

@@ -0,0 +1,40 @@
+require 'lotus/utils/string'
+
+module Lotus
+  module Action
+    # Routing helper for full stack Lotus web applications.
+    #
+    # For a given application called <tt>Web::Application</tt>, at runtime
+    # Lotus creates a routes factory called <tt>Web::Routes</tt>.
+    #
+    # Included by default in every controller.
+    #
+    # @since 0.3.2
+    #
+    # @example Usage in controller
+    #   require 'lotus'
+    #
+    #   module Web::Controllers::Protected
+    #     class Index
+    #       include Web::Action
+    #
+    #       def call(params)
+    #         redirect_to routes.root_path
+    #       end
+    #     end
+    #   end
+    module RoutingHelpers
+      def self.included(base)
+        factory = "#{ Utils::String.new(base).namespace }::Routes"
+
+        base.class_eval <<-END_EVAL, __FILE__, __LINE__
+          private
+
+          def routes
+            #{ factory }
+          end
+        END_EVAL
+      end
+    end
+  end
+end

data/lib/lotus/config/cookies.rb

@@ -20,17 +20,38 @@ module Lotus
       # Prevent attackers to steal cookies via JavaScript,
       # Eg. alert(document.cookie) will fail
       #
-      # @param enabled [TrueClass, FalseClass] enable cookies
-      # @param options [Hash] optional cookies options
+      # @param options [Hash, TrueClass, FalseClass] optional cookies options
+      # @param configuration [Lotus::Configuration] the application configuration
       #
       # @since 0.3.0
       # @api private
       #
       # @see https://github.com/rack/rack/blob/master/lib/rack/utils.rb #set_cookie_header!
       # @see https://www.owasp.org/index.php/HttpOnly
-      def initialize(enabled = false, options = {})
-        @enabled         = enabled
-        @default_options = { httponly: true }.merge(options)
+      #
+      # @example Enable cookies with boolean
+      #   module Web
+      #     class Application < Lotus::Application
+      #       configure do
+      #         # ...
+      #         cookies true
+      #       end
+      #     end
+      #   end
+      #
+      # @example Enable cookies with options
+      #   module Web
+      #     class Application < Lotus::Application
+      #       configure do
+      #         # ...
+      #         cookies max_age: 300
+      #       end
+      #     end
+      #   end
+      def initialize(configuration, options = {})
+        @options         = options
+        @default_options = { httponly: true, secure: configuration.ssl? }
+        @default_options.merge!(options) if options.is_a?(::Hash)
       end
 
       # Return if cookies are enabled
@@ -40,7 +61,7 @@ module Lotus
       # @since 0.3.0
       # @api private
       def enabled?
-        !!@enabled
+        @options.respond_to?(:empty?) ? !@options.empty? : !!@options
       end
     end
   end

data/lib/lotus/configuration.rb

@@ -465,10 +465,9 @@ 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 cookies(value, options)
+    # @overload cookies(options)
     #   Sets the given value with their options.
-    #   @param value [TrueClass, FalseClass]
-    #   @param options [Hash]
+    #   @param options [Hash, TrueClass, FalseClass]
     #
     # @overload cookies
     #   Gets the value.
@@ -483,7 +482,7 @@ module Lotus
     #   end
     #
     #   Bookshelf::Application.configuration.cookies
-    #     # => #<Lotus::Config::Cookies:0x0000000329f880 @enabled=false, @default_options={:httponly=>true}>
+    #     # => #<Lotus::Config::Cookies:0x0000000329f880 @options={}, @default_options={:httponly=>true, :secure=>false}>
     #
     # @example Setting the value
     #   require 'lotus'
@@ -491,34 +490,18 @@ module Lotus
     #   module Bookshelf
     #     class Application < Lotus::Application
     #       configure do
-    #         cookies true, { domain: 'lotusrb.org' }
+    #         cookies domain: 'lotusrb.org'
     #       end
     #     end
     #   end
     #
     #   Bookshelf::Application.configuration.cookies
-    #     # => #<Lotus::Config::Cookies:0x0000000329f880 @enabled=true, @default_options={:domain=>'lotusrb.org', :httponly=>true}>
-    #
-    # @example Setting a new value after one is set.
-    #   require 'lotus'
-    #
-    #   module Bookshelf
-    #     class Application < Lotus::Application
-    #       configure do
-    #         cookies false
-    #         cookies true
-    #       end
-    #     end
-    #   end
-    #
-    #   Bookshelf::Application.configuration.cookies
-    #     # => #<Lotus::Config::Cookies:0x0000000329f880 @enabled=true, @default_options={:httponly=>true}>
-    #
-    def cookies(value = nil, options = {})
-      if value.nil?
-        @cookies ||= Config::Cookies.new
+    #     # => #<Lotus::Config::Cookies:0x0000000329f880 @options={:domain=>'lotusrb.org'}, @default_options={:domain=>'lotusrb.org', :httponly=>true, :secure=>false}>
+    def cookies(options = nil)
+      if options.nil?
+        @cookies ||= Config::Cookies.new(self, options)
       else
-        @cookies = Config::Cookies.new(value, options)
+        @cookies = Config::Cookies.new(self, options)
       end
     end
 

data/lib/lotus/generators/action.rb

@@ -27,7 +27,8 @@ module Lotus
       def initialize(command)
         super
 
-        @controller, @action = name.split(ACTION_SEPARATOR)
+        @name = Utils::String.new(name).underscore
+        @controller, @action = @name.split(ACTION_SEPARATOR)
         @controller_name     = Utils::String.new(@controller).classify
         @action_name         = Utils::String.new(@action).classify
 
@@ -38,6 +39,7 @@ module Lotus
       # @api private
       def start
         assert_existing_app!
+        assert_action!
 
         opts = {
           app:           app,
@@ -88,6 +90,14 @@ module Lotus
         end
       end
 
+      # @since 0.3.2
+      # @api private
+      def assert_action!
+        if @action.nil?
+          raise Lotus::Commands::Generate::Error.new("Unknown action, please add action's name with this syntax controller_name#action_name")
+        end
+      end
+
       # @since 0.3.0
       # @api private
       def generate_route
@@ -98,7 +108,7 @@ module Lotus
 
         # Insert at the top of the file
         cli.insert_into_file _routes_path, before: /\A(.*)/ do
-          "get '/#{ @controller }', to: '#{ name }'\n"
+          "get '/#{ @controller }', to: '#{ @name }'\n"
         end
       end
 

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

@@ -2,6 +2,7 @@
 ENV['LOTUS_ENV'] ||= 'test'
 
 require_relative '../config/environment'
+Lotus::Application.preload!
 
 Dir[__dir__ + '/support/**/*.rb'].each { |f| require f }
 
@@ -24,9 +25,6 @@ Dir[__dir__ + '/support/**/*.rb'].each { |f| require f }
 #
 # 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.

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

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

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

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

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

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

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

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

data/lib/lotus/generators/model.rb

@@ -10,7 +10,7 @@ module Lotus
       def initialize(command)
         super
 
-        @model = app_name
+        @model = Utils::String.new(app_name).underscore
         @model_name = Utils::String.new(@model).classify
 
         cli.class.source_root(source)

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

@@ -63,7 +63,9 @@ module <%= config[:classified_slice_name] %>
       #                      See #scheme and #ssl?
       #          :httponly - Prevent JavaScript access (Boolean - true by default)
       #
-      # cookies true, {}
+      # cookies true
+      # or
+      # cookies max_age: 300
 
       # Enable sessions
       # Argument: Symbol the Rack session adapter

data/lib/lotus/loader.rb

@@ -3,9 +3,9 @@ require 'lotus/utils/kernel'
 require 'lotus/utils/string'
 require 'lotus/routes'
 require 'lotus/routing/default'
-require 'lotus/action/cookies'
 require 'lotus/action/session'
 require 'lotus/config/security'
+require 'lotus/action/routing_helpers'
 
 module Lotus
   # Load an application
@@ -56,10 +56,12 @@ module Lotus
           })
 
           if config.cookies.enabled?
+            require 'lotus/action/cookies'
             prepare { include Lotus::Action::Cookies }
             cookies config.cookies.default_options
           end
           prepare { include Lotus::Action::Session } if config.sessions.enabled?
+          prepare { include Lotus::Action::RoutingHelpers }
 
           config.controller.__apply(self)
         end

data/lib/lotus/root.rb

@@ -0,0 +1,7 @@
+require 'lotus/environment'
+
+module Lotus
+  def self.root
+    Lotus::Environment.new.root
+  end    
+end

data/lib/lotus/version.rb

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

data/lib/lotus.rb

@@ -10,6 +10,17 @@ require 'lotus/environment'
 #
 # @see http://lotusrb.org
 module Lotus
+  # Return root of the project (top level directory).
+  #
+  # @return [Pathname] root path
+  #
+  # @since 0.3.2
+  #
+  # @example
+  #   Lotus.root # => #<Pathname:/Users/luca/Code/bookshelf>
+  def self.root
+    environment.root
+  end
 
   # Return the current environment
   #
@@ -22,7 +33,7 @@ module Lotus
   # @example
   #   Lotus.env => "development"
   def self.env
-    Environment.new.environment
+    environment.environment
   end
 
   # Check to see if specified environment(s) matches the current environment.
@@ -50,6 +61,16 @@ module Lotus
   #   Lotus.env?(:development, :test)   # => true
   #   Lotus.env?(:production, :staging) # => false
   def self.env?(*names)
-    Environment.new.environment?(*names)
+    environment.environment?(*names)
+  end
+
+  # Return environment
+  #
+  # @return [Lotus::Environment] environment
+  #
+  # @api private
+  # @since 0.3.2
+  def self.environment
+    Environment.new
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lotusrb
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-15 00:00:00.000000000 Z
+date: 2015-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lotus-utils
@@ -192,6 +192,7 @@ files:
 - README.md
 - bin/lotus
 - lib/lotus.rb
+- lib/lotus/action/routing_helpers.rb
 - lib/lotus/application.rb
 - lib/lotus/application_name.rb
 - lib/lotus/cli.rb
@@ -271,6 +272,7 @@ files:
 - lib/lotus/lotusrc.rb
 - lib/lotus/middleware.rb
 - lib/lotus/rendering_policy.rb
+- lib/lotus/root.rb
 - lib/lotus/routes.rb
 - lib/lotus/routing/default.rb
 - lib/lotus/setup.rb