hanami-controller 1.0.0.beta2 → 1.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a55f1d51fe4e8c7f3d631f070eab1233fadc0c3e
-  data.tar.gz: c9eb6f944227efb95943885e866adf40be3614dd
+  metadata.gz: 051cedd7011bacf9ca4f4fd4b98d8b61c618ef63
+  data.tar.gz: bfbc96dddca32aab07238ba15068fedae3abddae
 SHA512:
-  metadata.gz: 01cbf64f7661609247d8eeb2ed3b73168a0e21dbcd69f48f60bd79d828db788099bdd70f4192a47090e8babd007faa75ac50d6d480dc9235d5aa39a1fe141961
-  data.tar.gz: f24e1ee54fe5b990d4261c92889d602dd9e6fd9dfaef31dc975a6ff122a32ffc69c5c806b07cc24931919dac68d2a7ad152b841c9a1c61f61c6a3627fadc99cb
+  metadata.gz: 45d30eefef1706ddb0db5ff78083c778e6ae8eff2f34c3a434ec2df94883898a4ad5a9c9d6b5747664b9d17d4f872d0bf7b18c1dbce77bc1fce3f3e810c19d45
+  data.tar.gz: 9303820f4bd07c513945ec6008a52b2abf03b12b4b785853de7cc2aed436e91f08aa6ee08bf611f465d8351890e8f053d16b28be05afb697b3c7976fb5202da4

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Hanami::Controller
 Complete, fast and testable actions for Rack
 
+## v1.0.0.beta3 - 2017-03-17
+### Changed
+- [Luca Guidi] `Action#flash` is now public API
+
 ## v1.0.0.beta2 - 2017-03-02
 ### Added
 - [Marcello Rocha] Add `Action#unsafe_send_file` to send files outside of the public directory of a project

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright © 2014-2016 Luca Guidi
+Copyright © 2014-2017 Luca Guidi
 
 MIT License
 

data/README.md

@@ -202,8 +202,8 @@ class Signup
   params do
     required(:first_name).filled(:str?)
     required(:last_name).filled(:str?)
-    required(:email).confirmation.filled?(:str?, format?: /@/)
-    required(:password).confirmation.filled(:str?)
+    required(:email).filled?(:str?, format?: /\A.+@.+\z/)
+    required(:password).filled(:str?).confirmation
     required(:terms_of_service).filled(:bool?)
     required(:age).filled(:int?, included_in?: 18..99)
     optional(:avatar).filled(size?: 1..(MEGABYTE * 3))
@@ -940,7 +940,7 @@ class Csv
     self.format = :csv
     self.body = Enumerator.new do |yielder|
       yielder << csv_header
-      
+
       # Expensive operation is streamed as each line becomes available
       csv_body.each_line do |line|
         yielder << line
@@ -950,7 +950,7 @@ class Csv
 end
 ```
 
-Note: 
+Note:
 * In development, Hanami' code reloading needs to be disabled for streaming to work. This is because `Shotgun` interferes with the streaming action. You can disable it like this `hanami server --code-reloading=false`
 * Streaming does not work with WEBrick as it buffers its response. We recommend using `puma`, though you may find success with other servers
 
@@ -1204,6 +1204,6 @@ __Hanami::Controller__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Copyright
 
-Copyright © 2014-2016 Luca Guidi – Released under MIT License
+Copyright © 2014-2017 Luca Guidi – Released under MIT License
 
 This project was formerly known as Lotus (`lotus-controller`).

data/lib/hanami/action/base_params.rb

@@ -7,12 +7,14 @@ module Hanami
       # The key that returns raw input from the Rack env
       #
       # @since 0.7.0
+      # @api private
       RACK_INPUT    = 'rack.input'.freeze
 
       # The key that returns router params from the Rack env
       # This is a builtin integration for Hanami::Router
       #
       # @since 0.7.0
+      # @api private
       ROUTER_PARAMS = 'router.params'.freeze
 
       # The key that returns Rack session params from the Rack env
@@ -46,6 +48,7 @@ module Hanami
       # @return [Params]
       #
       # @since 0.7.0
+      # @api private
       def initialize(env)
         @env    = env
         @raw    = _extract_params

data/lib/hanami/action/cache.rb

@@ -20,7 +20,7 @@ module Hanami
       # @since 0.3.0
       # @api private
       #
-      # @see http://www.ruby-doc.org/core-2.1.2/Module.html#method-i-included
+      # @see http://www.ruby-doc.org/core/Module.html#method-i-included
       def self.included(base)
         base.class_eval do
           include CacheControl, Expires
@@ -51,7 +51,6 @@ module Hanami
       # @return void
       #
       # @since 0.3.0
-      # @api public
       #
       # @example
       #   require 'hanami/controller'
@@ -74,7 +73,6 @@ module Hanami
       #
       #     end
       #   end
-      #
       def cache_control(*values)
         cache_control = CacheControl::Directives.new(*values)
         headers.merge!(cache_control.headers)
@@ -91,7 +89,6 @@ module Hanami
       # @return void
       #
       # @since 0.3.0
-      # @api public
       #
       # @example
       #   require 'hanami/controller'
@@ -115,7 +112,6 @@ module Hanami
       #
       #     end
       #   end
-      #
       def expires(amount, *values)
         expires = Expires::Directives.new(amount, *values)
         headers.merge!(expires.headers)
@@ -132,7 +128,6 @@ module Hanami
       # @return void
       #
       # @since 0.3.0
-      # @api public
       #
       # @example
       #   require 'hanami/controller'

data/lib/hanami/action/cache/cache_control.rb

@@ -3,19 +3,19 @@ require 'hanami/action/cache/directives'
 module Hanami
   module Action
     module Cache
-
       # Module with Cache-Control logic
       #
       # @since 0.3.0
       # @api private
       module CacheControl
-
         # The HTTP header for Cache-Control
         #
         # @since 0.3.0
         # @api private
         HEADER = 'Cache-Control'.freeze
 
+        # @since 0.3.0
+        # @api private
         def self.included(base)
           base.class_eval do
             extend ClassMethods
@@ -23,11 +23,17 @@ module Hanami
           end
         end
 
+        # @since 0.3.0
+        # @api private
         module ClassMethods
+          # @since 0.3.0
+          # @api private
           def cache_control(*values)
             @cache_control_directives ||= Directives.new(*values)
           end
 
+          # @since 0.3.0
+          # @api private
           def cache_control_directives
             @cache_control_directives || Object.new.tap do |null_object|
               def null_object.headers
@@ -51,14 +57,16 @@ module Hanami
         # Class which stores CacheControl values
         #
         # @since 0.3.0
-        #
         # @api private
-        #
         class Directives
+          # @since 0.3.0
+          # @api private
           def initialize(*values)
             @directives = Hanami::Action::Cache::Directives.new(*values)
           end
 
+          # @since 0.3.0
+          # @api private
           def headers
             if @directives.any?
               { HEADER => @directives.join(', ') }

data/lib/hanami/action/cache/conditional_get.rb

@@ -25,22 +25,29 @@ module Hanami
       #
       # @since 0.3.0
       # @api private
-      #
       class ETag
+        # @since 0.3.0
+        # @api private
         def initialize(env, value)
           @env, @value = env, value
         end
 
+        # @since 0.3.0
+        # @api private
         def fresh?
           none_match && @value == none_match
         end
 
+        # @since 0.3.0
+        # @api private
         def header
           { ETAG => @value } if none_match
         end
 
         private
 
+        # @since 0.3.0
+        # @api private
         def none_match
           @env[IF_NONE_MATCH]
         end
@@ -51,20 +58,28 @@ module Hanami
       # @since 0.3.0
       # @api private
       class LastModified
+        # @since 0.3.0
+        # @api private
         def initialize(env, value)
           @env, @value = env, value
         end
 
+        # @since 0.3.0
+        # @api private
         def fresh?
           !Hanami::Utils::Blank.blank?(modified_since) && Time.httpdate(modified_since).to_i >= @value.to_i
         end
 
+        # @since 0.3.0
+        # @api private
         def header
           { LAST_MODIFIED => @value.httpdate } if modified_since
         end
 
         private
 
+        # @since 0.3.0
+        # @api private
         def modified_since
           @env[IF_MODIFIED_SINCE]
         end
@@ -76,14 +91,20 @@ module Hanami
       # @since 0.3.0
       # @api private
       class ConditionalGet
+        # @since 0.3.0
+        # @api private
         def initialize(env, options)
           @validations = [ ETag.new(env, options[:etag]), LastModified.new(env, options[:last_modified]) ]
         end
 
+        # @since 0.3.0
+        # @api private
         def fresh?
           yield if @validations.any?(&:fresh?)
         end
 
+        # @since 0.3.0
+        # @api private
         def headers
           @validations.map(&:header).compact.reduce Hash.new, :merge
         end

data/lib/hanami/action/cache/directives.rb

@@ -1,7 +1,6 @@
 module Hanami
   module Action
     module Cache
-
       # Cache-Control directives which have values
       #
       # @since 0.3.0
@@ -21,16 +20,24 @@ module Hanami
       # @since 0.3.0
       # @api private
       class ValueDirective
+        # @since 0.3.0
+        # @api private
         attr_reader :name
 
+        # @since 0.3.0
+        # @api private
         def initialize(name, value)
           @name, @value = name, value
         end
 
+        # @since 0.3.0
+        # @api private
         def to_str
           "#{@name.to_s.tr('_', '-')}=#{@value.to_i}"
         end
 
+        # @since 0.3.0
+        # @api private
         def valid?
           VALUE_DIRECTIVES.include? @name
         end
@@ -43,16 +50,24 @@ module Hanami
       # @since 0.3.0
       # @api private
       class NonValueDirective
+        # @since 0.3.0
+        # @api private
         attr_reader :name
 
+        # @since 0.3.0
+        # @api private
         def initialize(name)
           @name = name
         end
 
+        # @since 0.3.0
+        # @api private
         def to_str
           @name.to_s.tr('_', '-')
         end
 
+        # @since 0.3.0
+        # @api private
         def valid?
           NON_VALUE_DIRECTIVES.include? @name
         end
@@ -65,6 +80,8 @@ module Hanami
       class Directives
         include Enumerable
 
+        # @since 0.3.0
+        # @api private
         def initialize(*values)
           @directives = []
           values.each do |directive_key|
@@ -76,20 +93,28 @@ module Hanami
           end
         end
 
+        # @since 0.3.0
+        # @api private
         def each
           @directives.each { |d| yield d }
         end
 
+        # @since 0.3.0
+        # @api private
         def <<(directive)
           @directives << directive if directive.valid?
         end
 
+        # @since 0.3.0
+        # @api private
         def values
           @directives.delete_if do |directive|
             directive.name == :public && @directives.map(&:name).include?(:private)
           end
         end
 
+        # @since 0.3.0
+        # @api private
         def join(separator)
           values.join(separator)
         end

data/lib/hanami/action/cache/expires.rb

@@ -3,19 +3,19 @@ require 'hanami/action/cache/cache_control'
 module Hanami
   module Action
     module Cache
-
       # Module with Expires logic
       #
       # @since 0.3.0
       # @api private
       module Expires
-
         # The HTTP header for Expires
         #
         # @since 0.3.0
         # @api private
         HEADER = 'Expires'.freeze
 
+        # @since 0.3.0
+        # @api private
         def self.included(base)
           base.class_eval do
             extend ClassMethods
@@ -23,11 +23,17 @@ module Hanami
           end
         end
 
+        # @since 0.3.0
+        # @api private
         module ClassMethods
+          # @since 0.3.0
+          # @api private
           def expires(amount, *values)
             @expires_directives ||= Directives.new(amount, *values)
           end
 
+          # @since 0.3.0
+          # @api private
           def expires_directives
             @expires_directives || Object.new.tap do |null_object|
               def null_object.headers
@@ -51,21 +57,25 @@ module Hanami
         # Class which stores Expires directives
         #
         # @since 0.3.0
-        #
         # @api private
-        #
         class Directives
+          # @since 0.3.0
+          # @api private
           def initialize(amount, *values)
             @amount = amount
             @cache_control = Hanami::Action::Cache::CacheControl::Directives.new(*(values << { max_age: amount }))
           end
 
+          # @since 0.3.0
+          # @api private
           def headers
             { HEADER => time.httpdate }.merge(@cache_control.headers)
           end
 
           private
 
+          # @since 0.3.0
+          # @api private
           def time
             Time.now + @amount.to_i
           end

data/lib/hanami/action/callbacks.rb

@@ -197,10 +197,14 @@ module Hanami
         end
 
         private
+        # @since 0.1.0
+        # @api private
         def _run_before_callbacks(params)
           self.class.before_callbacks.run(self, params)
         end
 
+        # @since 0.1.0
+        # @api private
         def _run_after_callbacks(params)
           self.class.after_callbacks.run(self, params)
         end

data/lib/hanami/action/configurable.rb

@@ -41,6 +41,7 @@ module Hanami
 
       private
 
+      # @since 0.2.0
       def configuration
         self.class.configuration
       end

data/lib/hanami/action/cookies.rb

@@ -23,7 +23,6 @@ module Hanami
       # @return [Hanami::Action::CookieJar] cookies
       #
       # @since 0.1.0
-      # @api public
       #
       # @see Hanami::Controller::Configuration#cookies
       # @see Hanami::Action::CookieJar#[]=

data/lib/hanami/action/exposable/guard.rb

@@ -15,6 +15,7 @@ module Hanami
       # Prevents exposure of reserved words
       #
       # @since 0.7.1
+      # @api private
       #
       # @see Hanami::Action::Exposable::Guard::ClassMethods#expose
       # @see Hanami::Action::Exposable::Guard::ClassMethods#reserved_word?
@@ -47,6 +48,7 @@ module Hanami
           # @return [void]
           #
           # @since 0.7.1
+          # @api private
           def expose(*names)
             detect_reserved_words!(names)
 

data/lib/hanami/action/head.rb

@@ -78,7 +78,6 @@ module Hanami
       # quota via <tt>X-Rate-Limit</tt>.
       #
       # @since 0.5.0
-      # @api public
       #
       # @see Hanami::Action::HEAD#finish
       #

data/lib/hanami/action/mime.rb

@@ -40,7 +40,7 @@ module Hanami
       # @api private
       DEFAULT_CHARSET = 'utf-8'.freeze
 
-      # Most commom mime types used for responses
+      # Most commom MIME Types used for responses
       #
       # @since 1.0.0.beta1
       # @api private

data/lib/hanami/action/params.rb

@@ -26,6 +26,34 @@ module Hanami
         end
       end
 
+      # Define params validations
+      #
+      # @param blk [Proc] the validations definitions
+      #
+      # @since 0.7.0
+      #
+      # @see http://hanamirb.org/guides/validations/overview/
+      #
+      # @example
+      #   class Signup
+      #     MEGABYTE = 1024 ** 2
+      #     include Hanami::Action
+      #
+      #     params do
+      #       required(:first_name).filled(:str?)
+      #       required(:last_name).filled(:str?)
+      #       required(:email).filled?(:str?, format?: /\A.+@.+\z/)
+      #       required(:password).filled(:str?).confirmation
+      #       required(:terms_of_service).filled(:bool?)
+      #       required(:age).filled(:int?, included_in?: 18..99)
+      #       optional(:avatar).filled(size?: 1..(MEGABYTE * 3))
+      #     end
+      #
+      #     def call(params)
+      #       halt 400 unless params.valid?
+      #       # ...
+      #     end
+      #   end
       def self.params(&blk)
         validations(&blk || ->() {})
       end
@@ -37,6 +65,7 @@ module Hanami
       # @return [Params]
       #
       # @since 0.1.0
+      # @api private
       def initialize(env)
         @env = env
         super(_extract_params)
@@ -115,6 +144,7 @@ module Hanami
 
       private
 
+      # @api private
       def _params
         @result.output.merge(_router_params)
       end

data/lib/hanami/action/rack.rb

@@ -98,10 +98,12 @@ module Hanami
         end
       end
 
+      # @api private
       module ClassMethods
         # Build rack builder
         #
         # @return [Rack::Builder]
+        # @api private
         def rack_builder
           @rack_builder ||= begin
             extend Hanami::Action::Rack::Callable
@@ -242,6 +244,7 @@ module Hanami
         @request ||= ::Hanami::Action::Request.new(@_env)
       end
 
+      # Return parsed request body
       def parsed_request_body
         @_env.fetch(ROUTER_PARSED_BODY, nil)
       end

data/lib/hanami/action/rack/callable.rb

@@ -1,4 +1,3 @@
-
 module Hanami
   module Action
     module Rack
@@ -10,6 +9,7 @@ module Hanami
         #   see the examples below.
         #
         # @since 0.4.0
+        # @api private
         #
         # @see Hanami::Action::Rack::ClassMethods#rack_builder
         # @see Hanami::Action::Rack::ClassMethods#use

data/lib/hanami/action/request.rb

@@ -9,7 +9,6 @@ module Hanami
     #
     # @see http://www.rubydoc.info/gems/rack/Rack/Request
     class Request < ::Rack::Request
-
       # @raise [NotImplementedError]
       #
       # @since 0.3.1

data/lib/hanami/action/session.rb

@@ -80,7 +80,6 @@ module Hanami
       # @return [Hanami::Action::Flash] a Flash instance
       #
       # @since 0.3.0
-      # @api private
       #
       # @see Hanami::Action::Flash
       def flash

data/lib/hanami/action/throwable.rb

@@ -28,6 +28,8 @@ module Hanami
       # @see https://github.com/hanami/controller/issues/133
       RACK_EXCEPTION = 'rack.exception'.freeze
 
+      # @since 0.1.0
+      # @api private
       def self.included(base)
         base.extend ClassMethods
       end

data/lib/hanami/action/validatable.rb

@@ -9,6 +9,8 @@ module Hanami
       # @since 0.3.0
       PARAMS_CLASS_NAME = 'Params'.freeze
 
+      # @api private
+      # @since 0.1.0
       def self.included(base)
         base.extend ClassMethods
       end
@@ -48,6 +50,7 @@ module Hanami
         # @since 0.3.0
         #
         # @see Hanami::Action::Params
+        # @see http://hanamirb.org/guides/validations/overview/
         #
         # @example Anonymous Block
         #   require 'hanami/controller'
@@ -56,9 +59,9 @@ module Hanami
         #     include Hanami::Action
         #
         #     params do
-        #       param :first_name
-        #       param :last_name
-        #       param :email
+        #       required(:first_name)
+        #       required(:last_name)
+        #       required(:email)
         #     end
         #
         #     def call(params)
@@ -74,9 +77,9 @@ module Hanami
         #   require 'hanami/controller'
         #
         #   class SignupParams < Hanami::Action::Params
-        #     param :first_name
-        #     param :last_name
-        #     param :email
+        #     required(:first_name)
+        #     required(:last_name)
+        #     required(:email)
         #   end
         #
         #   class Signup

data/lib/hanami/controller.rb

@@ -4,6 +4,9 @@ require 'hanami/controller/configuration'
 require 'hanami/controller/version'
 require 'hanami/controller/error'
 
+# Hanami
+#
+# @since 0.1.0
 module Hanami
   # A set of logically grouped actions
   #
@@ -37,6 +40,8 @@ module Hanami
     #
     # @see Hanami::Action::Mime#format=
     class UnknownFormatError < Hanami::Controller::Error
+      # @since 0.2.0
+      # @api private
       def initialize(format)
         super("Cannot find a corresponding Mime type for '#{ format }'. Please configure it with Hanami::Controller::Configuration#format.")
       end
@@ -130,7 +135,7 @@ module Hanami
     #
     # @return [Module] a copy of Hanami::Controller
     #
-    # @since 0.2.0
+    # @since 0.2.0
     #
     # @see Hanami::Controller#dupe
     # @see Hanami::Controller::Configuration
@@ -252,4 +257,3 @@ module Hanami
     end
   end
 end
-

data/lib/hanami/controller/version.rb

@@ -3,6 +3,6 @@ module Hanami
     # Defines the version
     #
     # @since 0.1.0
-    VERSION = '1.0.0.beta2'.freeze
+    VERSION = '1.0.0.beta3'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-controller
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta2
+  version: 1.0.0.beta3
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-02 00:00:00.000000000 Z
+date: 2017-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack