mumukit-core 1.13.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f1171e9bc75ea6096afe03f8a30b15c32efafa0abbd2aef71f5ba96a32da23f
-  data.tar.gz: fad237169e5d66e359d831f3abe2456d42e82d2765ca821ebca8a4078357afc2
+  metadata.gz: 194cf145fd0c4c23370ed1e13c5c57bd0547ae1a471f70dd528b7da057f95493
+  data.tar.gz: 96378e2042dddcb61e19f120b1c7450b46bee8883a33d4431548eff2b5171281
 SHA512:
-  metadata.gz: 201065bf24ae05cc63f5bd631d7949a188a9f7fdcc87fce7516375b7e9e0403d007fb274d3add8561119a73efb1d10628df75eae308e679b389de692beb38251
-  data.tar.gz: e45109ef518aa076021c23a3d04bb619b6934f6c5a05c6485373691ba88686ef07e6e99294bda722257cd26a3088a0ba30ca6ebf2ad8cd83b8b487e79b815c75
+  metadata.gz: 0ee16a6494525dda508e7f625783669430462ef7af1fcb998632f80e3c1bb06dd15170251087850fd4bca30bfadce31db3b7bd5daf79518a43e7c992ff9c502f
+  data.tar.gz: 0d41784422345397e3fe753a2ea8e9639874549af9de5918008b6c36dc035591a86f0997b523645531a74597fc75460256e451e7621175b83152cc60ad8a47d2

data/lib/mumukit/core.rb

@@ -3,12 +3,28 @@ require 'active_support/all'
 
 module Mumukit
   module Core
+    class << self
+      def test_mode!
+        Class.class_eval do
+          break if method_defined? :__mumukit_core_contract_new__
+          alias_method :__mumukit_core_contract_new__, :new
+
+          def new(*args, &block)
+            validate_complies_with_contract!
+            __mumukit_core_contract_new__(*args, &block)
+          end
+        end
+      end
+    end
   end
 end
 
+Mumukit::Core.test_mode! if %w(RACK_ENV RAILS_ENV).any? { |it| ENV[it] == 'test' }
+
 require_relative './core/status'
 require_relative './core/object'
 require_relative './core/module'
+require_relative './core/class'
 require_relative './core/json'
 require_relative './core/hash'
 require_relative './core/string'

data/lib/mumukit/core/array.rb

@@ -7,13 +7,9 @@ class Array
     end
   end
 
-  def to_h
-    Hash[self]
-  end
-
   def to_csv
     CSV.generate do |csv|
       each { |hash| csv << hash.values }
     end
   end
-end
+end

data/lib/mumukit/core/class.rb

@@ -0,0 +1,8 @@
+class Class
+  class ContractBreachError < Exception
+  end
+
+  def validate_complies_with_contract!
+    raise ContractBreachError.new "class #{name} does not implement contract #{contract_breaches}!" if breaches_contract?
+  end
+end

data/lib/mumukit/core/module.rb

@@ -6,11 +6,113 @@ class Module
     end
   end
 
-  def patch(method_name, &block)
-    method_proc = instance_method method_name
+  # Redefines a previous definition of the given method.
+  # It takes a block with the original arguments and the `hyper`
+  # reference to the original definition
+  def patch(selector, &block)
+    revamp selector do |_, this, *args, hyper|
+      this.instance_exec(*args, hyper, &block)
+    end
+  end
+
+  # `revamp` is a `patch` generalization
+  # that accepts multiple selectors and
+  # takes a more general callback, like the following:
+  #
+  # ```
+  # revamp :foo, :bar do |selector, this, *args, hyper|
+  #   puts "sending #{selector} to #{this}..."
+  #   result = hyper.call(*args)
+  #   puts "done. result is #{result}"
+  #   result
+  # end
+  # ```
+  #
+  # `revamp` should be preferred to `patch` when more control or performance
+  # is required
+  def revamp(*selectors, selector_transformer: nil, &block)
+    selectors.each do |selector|
+      method_proc = instance_method selector
+      selector_transform = selector_transformer ? selector_transformer.call(selector) : selector
+
+      define_method selector do |*args|
+        block.call(selector_transform, self, *args, method_proc.bind(self))
+      end
+    end
+  end
 
-    define_method method_name do |*args|
-      instance_exec(*args, method_proc.bind(self), &block)
+  # Revamps an accessor. This method is similar to `revamp`,
+  # but:
+  #
+  #  * assumes a 0 arguments array
+  #  * takes the accessor's original result instead of the `hyper` reference
+  #
+  # As a consequence, `revamp_accessor` can not alter the way and the moment
+  # the original method is evaluated.
+  #
+  # ```
+  # revamp_accessor :foo, :bar do |selector, this, result|
+  #   puts "result of sending #{selector} to #{this} is #{result}"
+  #   result
+  # end
+  # ```
+  #
+  # :warning: the block will not be called on a `nil` result
+  def revamp_accessor(*selectors, &block)
+    revamp(*selectors) do |selector, this, hyper|
+      result = hyper.call
+      result && block.call(selector, this, result)
     end
   end
+
+  # Caches an accessor, using the idiom `@__foo__ ||= foo`. For example, the following code:
+  #
+  # ```
+  # def foo
+  #   @__foo__ ||= #...implementation...
+  # end
+  # ```
+  #
+  # Can be turned into:
+  #
+  # ```
+  # def foo
+  #   #...implementation...
+  # end
+  #
+  # cache_accessor :foo
+  # ```
+  #
+  def cache_accessor(*selectors)
+    revamp(*selectors, selector_transformer: proc { |it| "@__#{it}__".to_sym }) do |attr_name, this, hyper|
+      this.instance_variable_get(attr_name) || this.instance_variable_set(attr_name, hyper.call)
+    end
+  end
+
+  def rewrite(selector, &block)
+    raise "method #{selector} was not previously defined here" unless method_defined?(selector)
+    define_method selector, &block
+  end
+
+  def contract
+    @contract ||= []
+  end
+
+  attr_writer :contract
+
+  def implements(*selectors)
+    self.contract += selectors
+  end
+
+  def full_contract
+    ancestors.flat_map(&:contract).uniq
+  end
+
+  def breaches_contract?
+    !contract_breaches.empty?
+  end
+
+  def contract_breaches
+    full_contract.reject { |it| method_defined? it }
+  end
 end

data/lib/mumukit/core/object.rb

@@ -19,4 +19,8 @@ class Object
   def struct(hash = {})
     hash.to_struct
   end
+
+  def filled?
+    self == false || present?
+  end
 end

data/lib/mumukit/core/status.rb

@@ -1,4 +1,4 @@
-[:passed, :passed_with_warnings, :failed, :errored, :aborted].each do |sym|
+[:passed, :passed_with_warnings, :failed, :errored, :aborted, :skipped].each do |sym|
   s = sym.to_s.freeze
   selector = "#{s}?"
   NilClass.class_eval do

data/lib/mumukit/core/version.rb

@@ -1,5 +1,5 @@
 module Mumukit
   module Core
-    VERSION = '1.13.0'
+    VERSION = '1.18.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mumukit-core
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.18.0
 platform: ruby
 authors:
 - Franco Leonardo Bulgarelli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-24 00:00:00.000000000 Z
+date: 2020-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -148,6 +148,7 @@ files:
 - lib/mumukit/core.rb
 - lib/mumukit/core/activemodel.rb
 - lib/mumukit/core/array.rb
+- lib/mumukit/core/class.rb
 - lib/mumukit/core/configurable.rb
 - lib/mumukit/core/file.rb
 - lib/mumukit/core/hash.rb
@@ -186,8 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Ruby core extensions for mumuki on top of active support