spectro 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bf7b456866166c224e87dca6b5526766412dd3f
-  data.tar.gz: 6e888e0846f3111e2af07f77b5d982c1e7fe6e20
+  metadata.gz: dc30381812690e2250df10dfb5ae634da7856afc
+  data.tar.gz: 74972d706ae592c219e262dcac13cc6962b1bfeb
 SHA512:
-  metadata.gz: de13b0e41bb2bf2fc3a0aedb8600593e0d587789faf99633a189faa0182f4f60d45bb4dc3abcbd2fbd0cbff350681f6203d246246eae76fc6682b6defdc2ba98
-  data.tar.gz: fe5c65a3242a62ca08a4bfd9936cfe39662b7dc8d5bcb20c5df2c0edacfebb90c5f5d929c33d4ce81fa9be32f25b0627af67b347dd6c76e3b70f62aa4071c2b4
+  metadata.gz: 8287affb8337e7db19ff8f349e7e0739e8ee62677f930b29335053d5302ce41847adacb6ed0eae1a8206c07297d53e744c741f30d89ac6c789b344fee46b396f
+  data.tar.gz: 716ad339a11b90203172115493295589bf6ee454f2b73d21c01392bb6da5f0d8b3aaaf6b7782b76f8fe3f735c72798fae4372a9989520b1296229040915ec46b

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Roberto Decurnex
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,7 +1,9 @@
-# Spectro
+![Spectro](spectro.png)
 
 Specs driven social meta-programming
 
+[![Gem Version](https://badge.fury.io/rb/spectro.svg)](http://badge.fury.io/rb/spectro)
+[![Gitter](https://badges.gitter.im/robertodecurnex/spectro.svg)](https://gitter.im/robertodecurnex/spectro?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 [![Build Status](https://api.travis-ci.org/robertodecurnex/spectro.png)](https://travis-ci.org/robertodecurnex/spectro)
 [![Code Climate](https://codeclimate.com/github/robertodecurnex/spectro/badges/gpa.svg)](https://codeclimate.com/github/robertodecurnex/spectro)
 [![Test Coverage](https://codeclimate.com/github/robertodecurnex/spectro/badges/coverage.svg)](https://codeclimate.com/github/robertodecurnex/spectro)
@@ -9,6 +11,8 @@ Specs driven social meta-programming
 
 ## Prototype
 
+Spectro will fetch an algorithm to cover the given spec form its DB and will then define the `#hello` method using it.
+
 ```ruby
 require 'spectro'
 
@@ -29,5 +33,51 @@ spec_for hello String -> String
 ```
 
 ```ruby
+sample = Sample.new
+
 sample.hello 'Eddie' #=> 'Say Hello to Eddie'
 ```
+
+## Working with Mocks
+
+### Scenarios
+
+* Keep coding while waiting for an algorithm that covers your specs
+* Using **Spectro** just to mock stuff
+
+```ruby
+require 'spectro'
+
+class EmailValidator
+
+  include Spectro
+
+  implements \
+    valid?: [:email]
+
+end
+
+__END__
+spec_for valid? String -> TrueClass|FalseClass
+  "valid@email.com"  -> true
+  "invalidATemail.com" -> false
+```
+
+```ruby 
+require 'email_validator' #=> Spectro::Exception::UndefinedMethodDefinition
+```
+
+```ruby
+Spectro.configure do |config|
+  config.enable_mocks!
+end
+
+require 'email_validator'
+
+email_validator = EmailValidator.new
+
+email_validator.valid?("valid@email.com") #=> true 
+email_validator.valid?("invalidATemail.com") #=> false 
+email_validator.valid?("unknown_param@email.com") #=> raise Spectro::Exception::UnkwnonMockResponse
+
+```

data/lib/spectro.rb

@@ -1,11 +1,16 @@
+require 'colorize'
 require 'digest'
 require 'forwardable'
+require 'net/http'
 require 'singleton'
+require 'uri'
 require 'yaml'
 
+require 'spectro/compiler'
 require 'spectro/config'
 require 'spectro/database'
 require 'spectro/exception'
+require 'spectro/http_client'
 require 'spectro/mock'
 require 'spectro/spec'
 
@@ -16,27 +21,27 @@ module Spectro
   def self.included klass
     klass.extend(ClassMethods)
   end
-  
+
   # Gives access to the Spectro::Config instance insde the given block
   #
   # Usage:
   #     Spectro.configure do |config|
   #       config.enable_mocks!
   #     end
-  def self.configure 
+  def self.configure
     yield Spectro::Config.instance
   end
-  
+
   module ClassMethods
 
     # Register the given method name supporting the given parameters.
     #
-    # Whenever Spectro::Config.mocks_enabled? is true it will try to cover unfulfilled 
-    # specs using the knwon rules as mocks. 
+    # Whenever Spectro::Config.mocks_enabled? is true it will try to cover unfulfilled
+    # specs using the known rules as mocks.
     #
-    # @param [{String, Symbol=><String, Symbol>}] interfaces hash of method names and required param names that the method supports
+    # @param [{String, Symbol=><String, Symbol>}] interfaces hash of method names and required param names supported by the method
     def implements interfaces
-      file_path = caller.first.match(/#{Dir.pwd}\/(.+):\d+:in .+/)[1]
+      file_path = caller.first.match(/(?:^|#{Dir.pwd}\/)([^\/].*):\d+:in .+/)[1]
       interfaces.each do |method_name, required_params|
         λ = Spectro::Database.fetch(file_path, method_name, *required_params) || Spectro::Mock.create(file_path, method_name)
 
@@ -50,3 +55,5 @@ module Spectro
 
 end
 
+# Loads the current project config, if present
+load '.spectro/config' if File.exist?('.spectro/config')

data/lib/spectro/client.rb

@@ -4,13 +4,23 @@ require 'thor'
 module Spectro
 
   class Client < Thor
-  
+
     desc 'compile', 'Parses the current project looking for unfulfilled specs and looks for suitable lambdas in the repos. It then updates the cache with them.'
     def compile
-      require 'spectro/compiler'
       Spectro::Compiler.compile
     end
 
+    desc 'init', 'Initialize the current folder as an Spectro project, creating all the required files and folders.'
+    option :f, type: :boolean
+    def init
+      Spectro::Compiler.init options
+    end
+
+    desc 'upload', 'Uploads the undefined specs to the Hivein order to let the comunnity work and discuss over them.'
+    def upload
+      Spectro::HTTPClient.upload_undefined_specs
+    end
+
   end
 
 end

data/lib/spectro/compiler.rb

@@ -4,8 +4,8 @@ require 'yaml/store'
 
 module Spectro
 
-  # Spectro:Compiler is in charge of spectroan the projects and parse its files,
-  # updating the project Spectro index and dumping information about the missing 
+  # Spectro::Compiler is in charge of scan the projects and parse its files,
+  # updating the Spectroi's index and dumping information about the missing
   # implementations (specs without an associated lambda)
   class Compiler
 
@@ -13,32 +13,73 @@ module Spectro
 
     class << self
       extend Forwardable
-      def_delegators :instance, :compile
+      def_delegators :instance, :compile, :init
     end
 
-    # Filters the project files keeping those making use of Spectro.
-    # It them parses those files, check for missing implementations
-    # and creates an .spectro/undefined.yml with the specs of them.
+    # Filters the project files keeping those that make use of Spectro.
+    # It then parses them, check for missing implementations
+    # and creates an .spectro/undefined.yml with their specs.
     #
     # @return [Spectro::Compiler] self
-    def compile 
+    def compile
+      if !Dir.exist?('.spectro')
+        abort "\n" + "This folder has not been initialzed as an Spectro project. Please run ".white.on_red + " spectro init ".white.on_light_black + " before compiling.".white.on_red + "\n\n"
+      end
+
       undefined_yaml = YAML::Store.new(".spectro/undefined.yml")
       undefined_yaml.transaction do
         targets().map do |path|
           missing_specs = missing_specs_from_file(path)
 
           next if missing_specs.empty?
-           
+
           undefined_yaml[path] = missing_specs
         end
       end
-     
+
       return self
     end
 
+  # Init the current folder as an Spectro project, creating all the required files and folders
+  # `.spectro` confg file
+  # `.spectro/index.yml` which will hold the mappings between Files/Method names and defined lambdas
+  # `.spectro/undefined.yml` which will hold the collection of spec definitions not yet fulfilled
+  # `.spectro/cache` folder that will hold the source code of the retrieved lambdas
+  #
+  # @return [Spectro::Compiler] self
+  def init options={}
+    if File.exist?('.spectro/config') && !options[:f]
+      abort "\n" + "Project already initialized. If you want to reset the curret setup you can run ".black.on_yellow + " spectro init -f ".white.on_light_black + "\n\n"
+    end
+
+    Dir.exist?('.spectro') || Dir.mkdir('.spectro')
+    Dir.exist?('.spectro/cache') || Dir.mkdir('.spectro/cache')
+    File.open('.spectro/config', 'w') do |file|
+      file.write <<-CONFIG
+#!/usr/bin/env ruby
+
+Spectro.configure do |config|
+# Sets a custom API Hostname if needed
+# config.api_hostname = 'localhost:9292'
+#
+# Instead of failing in case of unfulfilled functions it will try to use the local specs to get a result
+# config.enable_mocks!
+end
+      CONFIG
+    end
+    File.open('.spectro/index.yml', 'w') do |file|
+    end
+    File.open('.spectro/undefined.yml', 'w') do |file|
+    end
+
+    puts "\n" + "The project has been successfully initialized".black.on_blue + "\n\n"
+
+    return self
+  end
+
   private
 
-    # Parse the specs on the given file path and return those specs 
+    # Parse the specs on the given file path and return those
     # that have not been fulfilled or need to be updated.
     #
     # @param [String] path target file path
@@ -50,13 +91,13 @@ module Spectro
       end
     end
 
-    # Filter project's rb files returning an Array of files 
+    # Filter project's rb files returning an Array of files
     # containinig specs to be parsed.
     #
     # @return [<String>] array of files to be parsed
     def targets
       return %x[ grep -Pzrl --include="*.rb" "^__END__.*\\n.*spec_for" . ].split("\n").collect do |path|
-        path[2..-1] 
+        path[2..-1]
       end
     end
 

data/lib/spectro/config.rb

@@ -2,15 +2,33 @@ module Spectro
 
   class Config
 
+    API_HOSTNAME = 'localhost:9292'
+
     attr_accessor :mocks_enabled
- 
+
     include Singleton
 
     class << self
       extend Forwardable
-      def_delegators :instance, :enable_mocks!, :mocks_enabled?
+      def_delegators :instance, :api_hostname, :api_hostname=, :enable_mocks!, :mocks_enabled?
+    end
+
+    # Returns the API Hostname from the config
+    # or the default if missin
+    #
+    # @return [String] the API Hostname
+    def api_hostname
+      return @api_hostname || API_HOSTNAME
     end
-    
+
+    # Sets a custom API Hostname
+    #
+    # @param [String|NilClass] hostname the custom hostname or `nil` for the default
+    # @return [String|NilClass]
+    def api_hostname= hostname
+      @api_hostname = hostname
+    end
+
     # Sets mocks_enabled to true
     #
     # @return [Spectro::Config] self
@@ -25,7 +43,7 @@ module Spectro
     def mocks_enabled?
       return !!self.mocks_enabled
     end
-  
+
   end
 
 end

data/lib/spectro/database.rb

@@ -2,9 +2,9 @@ module Spectro
 
   # Gives access to the current collection of
   # algorithms (lambdas) providing several ways
-  # to fetch specific elements by different criterias.
+  # to fetch specific elements by different criteria.
   class Database
-    
+
     include Singleton
 
     class << self
@@ -17,15 +17,21 @@ module Spectro
     def initialize
       self.cache = {}
     end
-    
+
     # Lazy loads the index.yml and returns it
     #
     # @return [Hash] the parsed index.yml
     def index
-      @index ||= YAML.load_file('./.spectro/index.yml')
+      return @index ||= load_index()
     end
-    
-    # Fetches and return the target lambda based on the 
+
+    # Sets the index cache to nil
+    # Just in case you want the database to parse the file once again
+    def reset_index
+      @index = nil
+    end
+
+    # Fetches and returns the target lambda based on the
     # given class, method name and required aprameters.
     #
     # @param [String] file_path relative path of the file that requests the lambda
@@ -40,6 +46,16 @@ module Spectro
       return self.cache[λ_id] ||= eval(File.read(".spectro/cache/#{λ_id}.rb"))
     end
 
+    private
+
+      # Loads and returns the current project index or returns
+      # an empty one if not found
+      def load_index
+        return {} if !File.exist?('.spectro/index.yml')
+
+        return YAML.load_file('.spectro/index.yml') || {}
+      end
+
   end
 
 end

data/lib/spectro/http_client.rb

@@ -0,0 +1,26 @@
+module Spectro
+
+  # Interact with the API exchanging specs and functions
+  class HTTPClient
+
+    include Singleton
+
+    class << self
+      extend Forwardable
+      def_delegators :instance, :upload_undefined_specs
+    end
+
+    def upload_undefined_specs
+      uri = URI.parse('http://' + Spectro::Config.api_hostname + '/api/specs')
+      file_path = '.spectro/undefined.yml'
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.body = File.read(file_path)
+
+      http.request(request)
+    end
+
+  end
+
+end

data/lib/spectro/mock.rb

@@ -16,9 +16,7 @@ module Spectro
         spec.signature.name == method_name.to_s
       end
       
-      param_names = Array.new(spec.signature.params_types.count) do |index|
-        ('a'.ord+index).chr
-      end
+      param_names = ('a'..'z').first(spec.signature.params_types.count)
       
       responses = spec.rules.inject({}) do |memo, rule|
         memo[rule.params] = rule.output  
@@ -26,13 +24,13 @@ module Spectro
       end
       
       return eval "
-        lambda do |#{param_names.join(',')}|
+        ->(#{param_names.join(',')}) {
           if !responses.has_key?([#{param_names.join(',')}])
             raise Spectro::Exception::UnknownMockResponse.new(file_path, method_name)          
           end
 
           return responses[[#{param_names.join(',')}]] 
-        end
+        }
       "
     end
 

data/lib/spectro/spec.rb

@@ -5,13 +5,15 @@ require 'spectro/spec/signature'
 module Spectro
 
   class Spec
- 
-    attr_accessor :md5, :rules, :signature
-   
+
+    attr_accessor :md5, :description, :rules, :signature
+
     # @param [String] spec md5
     # @param [Spectro::Spec::Signature] signature spec signature
+    # @param [String] description spec's description
     # @param [<Spectro::Spec::Rule>] rules collection of spec rules
-    def initialize md5, signature, rules
+    def initialize md5, signature, description, rules
+      self.description = description
       self.md5 = md5
       self.rules = rules
       self.signature = signature
@@ -19,10 +21,20 @@ module Spectro
 
     def == spec
       return \
+        self.description == spec.description && \
         self.signature == spec.signature && \
         self.rules == spec.rules
     end
 
+    def to_hash
+      return {
+        md5: self.md5,
+        description: self.description,
+        rules: self.rules.collect(&:to_hash),
+        signature: self.signature.to_hash
+      }
+    end
+
   end
 
 end

data/lib/spectro/spec/parser.rb

@@ -6,16 +6,16 @@ module Spectro
 
     # Parser to get Spectro::Spec instances from the metadata on the program's files
     class Parser
-      
+
       attr_accessor :file_path
- 
+
       # @param [String] file_path the path of the file to parse
       def initialize file_path
         self.file_path = file_path
       end
 
       # Create an instance of Spectro::Spec::Parser for the given file path
-      # and return the #parse response (the collection of Spectro::Spec instances 
+      # and returns the #parse response (the collection of Spectro::Spec instances
       # for the given file)
       #
       # @param [String] file_path the path of the file to parse
@@ -24,7 +24,7 @@ module Spectro
         Spectro::Spec::Parser.new(file_path).parse
       end
 
-      # Look for specs on the given file and parse them as Spectro::Specs
+      # Looks for specs on the given file and parses them as Spectro::Specs
       #
       # @return [<Spectro::Spec>] collection of specs found in the given file path
       def parse
@@ -32,33 +32,55 @@ module Spectro
         return raw_specs.split('spec_for')[1..-1].map do |raw_spec|
           self.parse_spec raw_spec
         end
-      end   
-   
+      end
+
       # Parses a raw spec and returns an Spectro::Spec instance
       #
       # @param [String] raw_spec raw spec
       # @return [Spectro::Spec] the Spectro::Spec instance
       def parse_spec raw_spec
-        spec_raw_signature, *spec_raw_rules = raw_spec.split("\n").reject(&:empty?)
-        
+        spec_raw_signature, *spec_raw_desc_and_rules  = raw_spec.split("\n").reject(&:empty?)
+
         spec_signature = self.parse_spec_signature(spec_raw_signature)
 
+        spec_raw_description = spec_raw_desc_and_rules.take_while do |desc_or_rule|
+          desc_or_rule.match(/^`/)
+        end
+
+        spec_description = self.parse_spec_description(spec_raw_description)
+
+        spec_raw_rules = spec_raw_desc_and_rules - spec_raw_description
+
         spec_rules = spec_raw_rules.map do |spec_raw_rule|
           self.parse_spec_rule(spec_raw_rule)
         end
 
         spec_md5 = Digest::MD5.hexdigest(raw_spec)
 
-        return Spectro::Spec.new(spec_md5, spec_signature, spec_rules)
+        return Spectro::Spec.new(spec_md5, spec_signature, spec_description, spec_rules)
+      end
+
+      # Returns the spec description from the raw spec description
+      #
+      # @param [String] spec_raw_description spec's raw description
+      # @return [String] spec description
+      def parse_spec_description(spec_raw_description)
+        return spec_raw_description.collect do |raw_description|
+          if raw_description[1..-1].empty?
+            next "\n"
+          end
+
+          next raw_description[1..-1].strip
+        end.join(' ').strip.gsub("\n ", "\n")
       end
 
-      # Returns a Spectro::Spec::Rule instance from the raw spec rule
+      # Returns an Spectro::Spec::Rule instance from the raw spec rule
       #
-      # @param [String] spec_raw_rule raw rule if the spec
-      # @return [Spectro::Spec::Rule]
+      # @param [String] spec_raw_rule raw rule of the spec
+      # @return [Spectro::Spec::Rule] spec rule instance
       def parse_spec_rule spec_raw_rule
         # REGEX HERE PLEASE, F%#&!@* EASY
-        raw_params, raw_output = spec_raw_rule.split('->').map(&:strip) 
+        raw_params, raw_output = spec_raw_rule.split('->').map(&:strip)
         output = eval(raw_output)
         params = raw_params.split(/,\s+/).map do |raw_param|
           eval(raw_param)
@@ -70,7 +92,7 @@ module Spectro
       # Returns a Spectro::Spec::Signature from the raw spec signature
       #
       # @param [String] spec_raw_signature raw signature of the spec
-      # @param [<Spectro::Spec::Signature]
+      # @param [<Spectro::Spec::Signature] spec signature instance
       def parse_spec_signature spec_raw_signature
         # REGEX HERE PLEASE, F%#&!@* EASY
         raw_name_and_params_types, output_type = spec_raw_signature.split('->').map(&:strip)

data/lib/spectro/spec/rule.rb

@@ -7,7 +7,7 @@ module Spectro
     class Rule
 
       attr_accessor :output, :params
-    
+
       # @param [<Object>] parmas set of input params
       # @param [<Object>] output expected result
       def initialize params, output
@@ -21,6 +21,13 @@ module Spectro
           self.params == rule.params
       end
 
+      def to_hash
+        return {
+          output: self.output,
+          params: self.params
+        }
+      end
+
     end
 
   end

data/lib/spectro/spec/signature.rb

@@ -1,12 +1,12 @@
 module Spectro
 
   class Spec
-    
-    # Representation of the required input/output types 
+
+    # Representation of the required input/output types
     class Signature
-    
+
       attr_accessor :name, :output_type, :params_types
-    
+
       # @param [String] name local name of the algorith (not sure if needed)
       # @param [<String>] param_types types of the expected input params
       # @param [String] output_type type of the expected output
@@ -23,6 +23,14 @@ module Spectro
           self.params_types == signature.params_types
       end
 
+      def to_hash
+        return {
+          name: self.name,
+          output_type: self.output_type,
+          params_type: self.params_types
+        }
+      end
+
     end
 
   end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: spectro
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Roberto Decurnex
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-13 00:00:00.000000000 Z
+date: 2016-04-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -114,8 +128,11 @@ executables:
 - spectro
 extensions: []
 extra_rdoc_files:
+- LICENSE
 - README.md
+- spectro.png
 files:
+- LICENSE
 - README.md
 - bin/spectro
 - lib/spectro.rb
@@ -126,11 +143,13 @@ files:
 - lib/spectro/exception.rb
 - lib/spectro/exception/undefined_method_definition.rb
 - lib/spectro/exception/unknown_mock_response.rb
+- lib/spectro/http_client.rb
 - lib/spectro/mock.rb
 - lib/spectro/spec.rb
 - lib/spectro/spec/parser.rb
 - lib/spectro/spec/rule.rb
 - lib/spectro/spec/signature.rb
+- spectro.png
 homepage: http://github.com/robertodecurnex/spectro
 licenses:
 - MIT
@@ -151,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
 summary: Specs driven social meta-programming