spectro 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1bf7b456866166c224e87dca6b5526766412dd3f
+  data.tar.gz: 6e888e0846f3111e2af07f77b5d982c1e7fe6e20
+SHA512:
+  metadata.gz: de13b0e41bb2bf2fc3a0aedb8600593e0d587789faf99633a189faa0182f4f60d45bb4dc3abcbd2fbd0cbff350681f6203d246246eae76fc6682b6defdc2ba98
+  data.tar.gz: fe5c65a3242a62ca08a4bfd9936cfe39662b7dc8d5bcb20c5df2c0edacfebb90c5f5d929c33d4ce81fa9be32f25b0627af67b347dd6c76e3b70f62aa4071c2b4

data/README.md

@@ -0,0 +1,33 @@
+# Spectro
+
+Specs driven social meta-programming
+
+[![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)
+[![YARD Docs](https://img.shields.io/badge/YARD-Docs-blue.svg)](http://www.rubydoc.info/github/robertodecurnex/spectro/master)
+
+## Prototype
+
+```ruby
+require 'spectro'
+
+class Sample
+
+  include Spectro
+
+  implements \
+    hello: [:name]
+
+end
+
+__END__
+spec_for hello String -> String
+  "Minion"  -> "Say Hello to Minion"
+  "Roberto" -> "Say Hello to Roberto"
+  "Roland"  -> "Say Hello to Roland"
+```
+
+```ruby
+sample.hello 'Eddie' #=> 'Say Hello to Eddie'
+```

data/bin/spectro

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'spectro/client'
+
+Spectro::Client.start

data/lib/spectro.rb

@@ -0,0 +1,52 @@
+require 'digest'
+require 'forwardable'
+require 'singleton'
+require 'yaml'
+
+require 'spectro/config'
+require 'spectro/database'
+require 'spectro/exception'
+require 'spectro/mock'
+require 'spectro/spec'
+
+# Specs driven social meta-programming
+module Spectro
+
+  # Extends the caller with the Spectro class methods on #include
+  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 
+    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. 
+    #
+    # @param [{String, Symbol=><String, Symbol>}] interfaces hash of method names and required param names that the method supports
+    def implements interfaces
+      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)
+
+        raise Spectro::Exception::UndefinedMethodDefinition.new(file_path, method_name) if λ.nil?
+
+        self.send(:define_method, method_name, &λ)
+      end
+    end
+
+  end
+
+end
+

data/lib/spectro/client.rb

@@ -0,0 +1,16 @@
+require 'spectro'
+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
+
+  end
+
+end

data/lib/spectro/compiler.rb

@@ -0,0 +1,65 @@
+require 'spectro'
+require 'spectro/spec/parser'
+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 
+  # implementations (specs without an associated lambda)
+  class Compiler
+
+    include Singleton
+
+    class << self
+      extend Forwardable
+      def_delegators :instance, :compile
+    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.
+    #
+    # @return [Spectro::Compiler] self
+    def compile 
+      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
+
+  private
+
+    # Parse the specs on the given file path and return those specs 
+    # that have not been fulfilled or need to be updated.
+    #
+    # @param [String] path target file path
+    # @return [<Spectro::Spec>] collection of specs not fulfilled or out of date
+    def missing_specs_from_file(path)
+      Spectro::Spec::Parser.parse(path).select do |spec|
+        index_spec = Spectro::Database.index[path] && Spectro::Database.index[path][spec.signature.name]
+        index_spec.nil? || index_spec['spec_md5'] != spec.md5
+      end
+    end
+
+    # 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] 
+      end
+    end
+
+  end
+
+end

data/lib/spectro/config.rb

@@ -0,0 +1,31 @@
+module Spectro
+
+  class Config
+
+    attr_accessor :mocks_enabled
+ 
+    include Singleton
+
+    class << self
+      extend Forwardable
+      def_delegators :instance, :enable_mocks!, :mocks_enabled?
+    end
+    
+    # Sets mocks_enabled to true
+    #
+    # @return [Spectro::Config] self
+    def enable_mocks!
+      self.mocks_enabled = true
+      return self
+    end
+
+    # Returns the current mocks policy (enabled or disabled)
+    #
+    # @return [TrueClass, FalseClass] whether mocks are enabled or not
+    def mocks_enabled?
+      return !!self.mocks_enabled
+    end
+  
+  end
+
+end

data/lib/spectro/database.rb

@@ -0,0 +1,45 @@
+module Spectro
+
+  # Gives access to the current collection of
+  # algorithms (lambdas) providing several ways
+  # to fetch specific elements by different criterias.
+  class Database
+    
+    include Singleton
+
+    class << self
+      extend Forwardable
+      def_delegators :instance, :fetch, :index
+    end
+
+    attr_accessor :cache
+
+    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')
+    end
+    
+    # Fetches and return 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
+    # @param [Symbol] method_name the method name that would be implemented
+    # @param [<Symbol>] required_params parameters that would be required by the lambda
+    # @return [Proc] the labda that would be implemented
+    def fetch file_path, method_name, *required_params
+      if self.index["#{file_path}"].nil? || self.index["#{file_path}"]["#{method_name}"].nil?
+        return nil
+      end
+      λ_id = self.index["#{file_path}"]["#{method_name}"]['lambda_id']
+      return self.cache[λ_id] ||= eval(File.read(".spectro/cache/#{λ_id}.rb"))
+    end
+
+  end
+
+end

data/lib/spectro/exception.rb

@@ -0,0 +1,9 @@
+require 'spectro/exception/undefined_method_definition'
+require 'spectro/exception/unknown_mock_response'
+
+module Spectro
+
+  module Exception
+  end
+
+end

data/lib/spectro/exception/undefined_method_definition.rb

@@ -0,0 +1,22 @@
+module Spectro
+
+  module Exception
+
+    class UndefinedMethodDefinition < ::Exception
+      
+      attr_accessor :file_path, :method_name
+    
+      def initialize file_path, method_name
+        self.file_path = file_path
+        self.method_name = method_name
+      end
+
+      def to_s
+        "[##{self.method_name}] has not been defiend for \"#{self.file_path}\". Verify the specs at \"#{self.file_path}\" and check the `spectro compile` output for more detailed information."
+      end
+
+    end
+
+  end
+
+end

data/lib/spectro/exception/unknown_mock_response.rb

@@ -0,0 +1,22 @@
+module Spectro
+
+  module Exception
+
+    class UnknownMockResponse < ::Exception
+      
+      attr_accessor :file_path, :method_name
+    
+      def initialize file_path, method_name
+        self.file_path = file_path
+        self.method_name = method_name
+      end
+
+      def to_s
+        "[##{self.method_name}] mock has not response defined for the given params. Verify the specs at \"#{self.file_path}\"."
+      end
+
+    end
+
+  end
+
+end

data/lib/spectro/mock.rb

@@ -0,0 +1,41 @@
+module Spectro
+
+  class Mock
+
+    # Creates a mock of the given method for the given file based
+    # on the spec rules.
+    # If mocks are not enabled it defaults to nil
+    #
+    # @param [String] file_path relative path of the file that requests the lambda
+    # @param [Symbol] method_name the method name that would be implemented
+    # @return [NilClass, Proc] the mock as Proc or nil if mocks are disabled
+    def self.create file_path, method_name
+      return nil unless Spectro::Config.mocks_enabled?
+     
+      spec = Spectro::Spec::Parser.parse(file_path).detect do |spec|
+        spec.signature.name == method_name.to_s
+      end
+      
+      param_names = Array.new(spec.signature.params_types.count) do |index|
+        ('a'.ord+index).chr
+      end
+      
+      responses = spec.rules.inject({}) do |memo, rule|
+        memo[rule.params] = rule.output  
+        memo
+      end
+      
+      return eval "
+        lambda do |#{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
+
+  end
+
+end

data/lib/spectro/spec.rb

@@ -0,0 +1,28 @@
+require 'spectro/spec/parser'
+require 'spectro/spec/rule'
+require 'spectro/spec/signature'
+
+module Spectro
+
+  class Spec
+ 
+    attr_accessor :md5, :rules, :signature
+   
+    # @param [String] spec md5
+    # @param [Spectro::Spec::Signature] signature spec signature
+    # @param [<Spectro::Spec::Rule>] rules collection of spec rules
+    def initialize md5, signature, rules
+      self.md5 = md5
+      self.rules = rules
+      self.signature = signature
+    end
+
+    def == spec
+      return \
+        self.signature == spec.signature && \
+        self.rules == spec.rules
+    end
+
+  end
+
+end

data/lib/spectro/spec/parser.rb

@@ -0,0 +1,86 @@
+require 'spectro'
+
+module Spectro
+
+  class Spec
+
+    # 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 
+      # for the given file)
+      #
+      # @param [String] file_path the path of the file to parse
+      # @return [<Spectro::Spec>] collection of specs found in the given file path
+      def self.parse(file_path)
+        Spectro::Spec::Parser.new(file_path).parse
+      end
+
+      # Look for specs on the given file and parse them as Spectro::Specs
+      #
+      # @return [<Spectro::Spec>] collection of specs found in the given file path
+      def parse
+        /.*^__END__$(?<raw_specs>.*)\Z/m =~ File.read(self.file_path)
+        return raw_specs.split('spec_for')[1..-1].map do |raw_spec|
+          self.parse_spec raw_spec
+        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_signature = self.parse_spec_signature(spec_raw_signature)
+
+        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)
+      end
+
+      # Returns a Spectro::Spec::Rule instance from the raw spec rule
+      #
+      # @param [String] spec_raw_rule raw rule if the spec
+      # @return [Spectro::Spec::Rule]
+      def parse_spec_rule spec_raw_rule
+        # REGEX HERE PLEASE, F%#&!@* EASY
+        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)
+        end
+
+        return Spectro::Spec::Rule.new(params, output)
+      end
+
+      # Returns a Spectro::Spec::Signature from the raw spec signature
+      #
+      # @param [String] spec_raw_signature raw signature of the spec
+      # @param [<Spectro::Spec::Signature]
+      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)
+        name, *params_types = raw_name_and_params_types.split(/,?\s+/).map(&:strip)
+
+        return Spectro::Spec::Signature.new(name, params_types, output_type)
+      end
+
+    end
+
+  end
+
+end

data/lib/spectro/spec/rule.rb

@@ -0,0 +1,28 @@
+module Spectro
+
+  class Spec
+
+    # Assert representation based on input params and an expected output.
+    # Meant to be used against an algorith to test its behavior.
+    class Rule
+
+      attr_accessor :output, :params
+    
+      # @param [<Object>] parmas set of input params
+      # @param [<Object>] output expected result
+      def initialize params, output
+        self.output = output
+        self.params = params
+      end
+
+      def == rule
+        return \
+          self.output == rule.output && \
+          self.params == rule.params
+      end
+
+    end
+
+  end
+
+end

data/lib/spectro/spec/signature.rb

@@ -0,0 +1,30 @@
+module Spectro
+
+  class Spec
+    
+    # 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
+      def initialize name, params_types, output_type
+        self.name = name
+        self.output_type = output_type
+        self.params_types = params_types
+      end
+
+      def == signature
+        return \
+          self.name == signature.name && \
+          self.output_type == signature.output_type && \
+          self.params_types == signature.params_types
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: spectro
+version: !ruby/object:Gem::Version
+  version: '0.2'
+platform: ruby
+authors:
+- Roberto Decurnex
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: decurnex.roberto@gmail.com
+executables:
+- spectro
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- bin/spectro
+- lib/spectro.rb
+- lib/spectro/client.rb
+- lib/spectro/compiler.rb
+- lib/spectro/config.rb
+- lib/spectro/database.rb
+- lib/spectro/exception.rb
+- lib/spectro/exception/undefined_method_definition.rb
+- lib/spectro/exception/unknown_mock_response.rb
+- lib/spectro/mock.rb
+- lib/spectro/spec.rb
+- lib/spectro/spec/parser.rb
+- lib/spectro/spec/rule.rb
+- lib/spectro/spec/signature.rb
+homepage: http://github.com/robertodecurnex/spectro
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Specs driven social meta-programming
+test_files: []
+has_rdoc: