inflect 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37e9a49f85f264598918cea57cf052fd4e4c3038
-  data.tar.gz: bf623f81cb5624cb61017d889a1823787facbf22
+  metadata.gz: fc4e321d2369326f998bf8b688106b8e559a4dde
+  data.tar.gz: 64906cd1b3ec23e8b30557813ed61b57ea7cfcbc
 SHA512:
-  metadata.gz: 69112d6ee47f88edfc6f4dd1bc5a55d53163e968e0719954bb0e164cba21f24d287f70af813344ec88a31b84e23f0145b430fa0732d51665e03df0b6f2d7730d
-  data.tar.gz: 94e9497d139d196f5e5b0caebb603d0f762fa82cb5bd07d40e5686abacd6168b7b9a8c38030374601b632020766c355ebbadc9f507c4a02716ca94cd78599a04
+  metadata.gz: 5ede50fc483b8cafea83a2ed1220deabc2f7235af2a81c862334212cd8183978e2f7e0af380b5efa8b1ba971aca5602474687a7f4bdabcf143ae20905b4fdaf1
+  data.tar.gz: ffb68bcf35ace2b363c46e0ca6befe380fa739c9b74e6c5d2db5389e41b0a9c6fd5362cd78297314b3e6741fa7502a34c9d5c8b7fec0e3b06076805bd0b20407

data/README.md

@@ -28,9 +28,9 @@ Or install it yourself as:
 
 Generate your Service:
 
-    $ bin/inflect generate:service weather
+    $ inflect generate:service weather
 
-Implement at least the ServiceWeather#handle method:
+Implement at least the WeatherService#handle method:
 
 ```ruby
 class WeatherService < Inflect::AbstractService

data/lib/generators/service_generator.rb

@@ -1,18 +1,23 @@
 require "thor"
 
+# Service Generator Class.
 class ServiceGenerator < Thor::Group
 	include Thor::Actions
 
+	# Defines the templates path.
 	def self.source_root
 		File.join(File.dirname(__FILE__), 'templates')
 	end
 
 	argument :name
+	# Responsible to generate the named service inside lib/services path
+	# of working directory.
 	def generate
 		template('service.tt', "lib/services/#{name}_service.rb")
 	end
 end
 
+# CLI command registrator.
 class CLI < Thor
 	register ServiceGenerator, "generate:service", "generate:service <service_name>", "Generates a service skeleton."
 end

data/lib/inflect/configuration.rb

@@ -3,10 +3,13 @@ module Inflect
     attr_reader :configuration
   end
 
+  # Configuration instance reference.
+  # @return [Inflect::Configuration]
   def self.configuration
     @configuration ||= Configuration.new
   end
 
+  # Method that allows configuration via block.
   def self.configure
     yield configuration if block_given?
   end
@@ -14,7 +17,12 @@ module Inflect
   # The class in charge of centralizing the application's
   # configuration.
   class Configuration
-    attr_reader :services_path, :locale_path
+    # Location of the services directory.
+    attr_accessor :services_path
+
+    # Location of the locale file.
+    attr_accessor :locale_path
+
 
     def initialize
       @services_path = File.join('lib', 'services')

data/lib/inflect/director.rb

@@ -5,6 +5,7 @@ module Inflect
   # The class in charge of managing the access
   # and selection of the services.
   class Director
+    # List of the services loaded successfully sorted by priority.
     attr_reader :services
 
     # @param services_path [String]
@@ -20,7 +21,7 @@ module Inflect
     # @param words [Array<String, Symbol>]
     def handle(words)
       selected_service = select_service(words)
-      selected_service.handle(words) unless selected_service.nil?
+      selected_service.serve(words) unless selected_service.nil?
     end
 
     private

data/lib/inflect/i18n.rb

@@ -3,7 +3,8 @@ require 'inflect/loader'
 module Inflect
   # Responsible of internationalization logic in the app.
   module I18n
-    # @param +key+ [Symbol, String] The key to error message.
+    # Returns error message inside the locale file.
+    # @param key [Symbol, String] The key to error message.
     # @return [String] Translation of the error message.
     def self.errors(key)
       Loader::locale['errors'][key.to_s]

data/lib/inflect/loader.rb

@@ -6,7 +6,6 @@ module Inflect
   # Responsable for loading all the services for Inflect
   # to comunicate with them and decide wich one will handle
   # the request.
-  #
   module Loader
     using Inflector
     # Loads all the services from the given path, sorted by
@@ -27,6 +26,8 @@ module Inflect
       services.sort
     end
 
+    # Loads the locale file from the given path
+    # Default in Inflect::Configuration.
     def self.locale(path = nil)
       @@locale ||= YAML.load_file(path || Inflect.configuration.locale_path)
     end

data/lib/inflect/response.rb

@@ -2,9 +2,16 @@ require 'inflect/loader'
 require 'inflect/i18n'
 
 module Inflect
-  #Responsible of encapsulate all the content of the service response
+  #Responsible of encapsulate all the content of the service response.
   class Response
-    attr_reader :content, :attributes, :timestamp, :errors
+    # Response content as itself.
+    attr_reader :content
+    # Response attributes like served_by and query_words.
+    attr_reader :attributes
+    # Response timestamp.
+    attr_reader :timestamp
+    #If is not a valid Response, errors lists the not valid attributes.
+    attr_reader :errors
 
     # @param content [String, Hash] The response of the service. Required.
     # @param description [Hash] Contains all the description of service response.
@@ -19,6 +26,7 @@ module Inflect
       @attributes     =   extract_attributes(description)
     end
 
+    # Keys of the required attributes.
     def self.attribute_keys
       @@attribute_keys = [:served_by, :query_words]
     end

data/lib/inflect/responsive.rb

@@ -3,21 +3,25 @@ require 'inflect/response'
 module Inflect
   # Allows services to respond an Inflect::Response instance.
   module Responsive
-
     # Method that creates Response instance.
-    # @param content [String, Hash] the response of the service.
-    # @return [Inflect::Response, nil] Returns nil if response is not valid.
-    def respond(content, options = {})
-      opts = merge_options(options)
+    # @param words [Array<String>] The queried words.
+    # @return [Inflect::Response | nil] Returns nil if response is not valid.
+    def serve(words)
+      content, options = handle(words)
+      opts = merge_options(options, { query_words: words })
       validate_response(Inflect::Response.new(content, opts))
     end
 
-    # Method that creates Response instance, skipping response validation.
-    # @param content [String, Hash] the response of the service.
-    # @return [Inflect::Response]
-    def respond!(content, options = {})
-      opts = merge_options(options)
-      Inflect::Response.new(content, opts)
+    # Supply more expressiveness and flexibility to the interface
+    # by allowing multiple ways of responding.
+    # @example Only String
+    #    respond 'String Response'
+    # @example As a String with options
+    #    respond 'String Response', opt: 'Extra options'
+    # @example Or as a Hash with options
+    #    respond({content: 'Hashed Response'}, {opt: 'Extra options'})
+    def respond(content, options= {})
+      [content, options]
     end
 
     private
@@ -26,8 +30,10 @@ module Inflect
       response.valid? ? response : nil
     end
 
-    def merge_options(options)
-      default_options.merge(options)
+    def merge_options(*options)
+      options.compact.inject(default_options) do |combined_options, current_options|
+        combined_options.merge current_options
+      end
     end
 
     # Set a Hash with required +option+ parameters for Inflect::Response.

data/lib/inflect/version.rb

@@ -1,3 +1,3 @@
 module Inflect
-  VERSION = "0.2.6"
+  VERSION = "0.3.0"
 end

data/lib/inflect.rb

@@ -3,14 +3,19 @@ require "inflect/director"
 require "inflect/configuration"
 require "inflect/abstract_service"
 
+# Module thats starts the service loading.
+# It is used as facade to handle queried words.
 module Inflect
   class << self
+    # Entry point to handle queried words.
+    # @return [nil, Inflect::Response]
     def handle(words)
       director.handle(words)
     end
 
     private
-
+    # Method that returns the Director instance reference.
+    # @return [Inflect::Director]
     def director
       @@director ||= Director.new(self.configuration.services_path)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inflect
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Santiago Figueiras
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-03 00:00:00.000000000 Z
+date: 2016-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler