mrubyc-test 0.5.3 → 0.7.0.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01fd00e01ce7b93d321a0345e0f658a9a1e9da234c1527b337a9e3fcc3b3b5fd
-  data.tar.gz: 969827d51ef5b523fef3399174529b7ffaf73952d2011ef8c32a59afd80361f6
+  metadata.gz: a7ba5b056b71ff5fc5377dda272e651a3784dfdc7627f3a746e7ce6bb30ff975
+  data.tar.gz: 2d587b1e8d998ba84434634ff0f7599ccec2bd69b41a41ac80693b057593fb67
 SHA512:
-  metadata.gz: a8ef624b18f81ec4a7071b11001fa55fdc059940a6358635fd86ec10c8537fc308cab9c5c29fba6252c3ee78996d3ccbe64078f3f22657b375cf91cbd933ab22
-  data.tar.gz: 466243707b3bd2f7f3c98c1b32d20c09607d72cb3b581b3b7f55e2b5544ec12df367e41c38b6fb3a2c7451e4e81dabc8bcfa9dd2112b3225d93dd113e50d348b
+  metadata.gz: a0c73ee66679987cc53adc9631e500f3cec3a70107807c3bebede1f3310dc2846db4e367a9eb215172b72c2535ddd7353a350bf50eeb45760d911ed7366ba6a5
+  data.tar.gz: a8a29d343d482ce81c2d83221f788d3cf9997739cafee556b2d3cd0342dee43d6e8a28880d5504e00fdc9465e68013e3da3c63dac754bd397ea72b4ad443e0c8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mrubyc-test (0.5.2)
+    mrubyc-test (0.6.2)
       activesupport (~> 6.0)
       rufo (~> 0.12)
       thor (~> 1.0)
@@ -9,37 +9,36 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.1)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
-    i18n (1.8.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.1)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    minitest (5.14.4)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rufo (0.12.0)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.3.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rufo (0.13.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -51,4 +50,4 @@ DEPENDENCIES
   rspec (~> 3.9)
 
 BUNDLED WITH
-   2.1.2
+   2.2.5

data/README.md

@@ -4,9 +4,9 @@
 
 mrubyc-test is an unit test framework for [mruby/c](https://github.com/mrubyc/mrubyc), supporting basic assertions, stub and mock.
 
-## Acknowledgements
+## Dependency
 
-The API design and implementation of this gem is greatly inspired by [test-unit](https://github.com/test-unit/test-unit). Thank the great work.
+- mrubyc-test 0.7.0+ depends on mrubyc 3.0+
 
 ## Features
 
@@ -38,7 +38,7 @@ Or install it yourself as:
 ## Usage
 
 Assuming you are using [mrubyc-utils](https://github.com/hasumikin/mrubyc-utils) to manage your project and [rbenv](https://github.com/rbenv/rbenv) to manage Ruby versions.
-It means you have `.mrubycconfig` and `.ruby-version` in the top directory of your project.
+It means you have `Mrubycfile` and `.ruby-version` in the top directory of your project.
 
 Besides, you have to locate mruby model files that are the target of testing like `mrblib/models/class_name.rb`
 
@@ -49,8 +49,8 @@ This is an example of ESP32 project:
 ```
 ~/your_project $ tree
 .
-├── .mrubycconfig               # Created by mrubyc-utils
-├── .ruby-version               # It should be mruby's version something like 'mruby-1.4.1'
+├── Mrubycfile                # Created by mrubyc-utils
+├── .ruby-version             # It should be mruby's version like 'mruby-3.0.0'
 ├── Makefile
 ├── build
 ├── components
@@ -119,17 +119,17 @@ end
 ```ruby
 class Sample
   def do_other_thing
-    is_to_be_hit()
+    is_to_be_hit(1, 2) # Two args for example
   end
 end
 ```
 
-You can test whether `#is_to_be_hit` method will be called:
+You can test whether `#is_to_be_hit(v1, v2)` method will be called:
 
 ```ruby
 def mock_case
   sample_obj = Sample.new
-  mock(sample_obj).is_to_be_hit
+  mock(sample_obj).is_to_be_hit(2) # `2` should be count of parameters
   sample_obj.do_other_thing
 end
 ```
@@ -144,6 +144,10 @@ end
 - Other assertions like LT(<), GTE(>=), include?, ...etc.
 - bla bla bla
 
+## Acknowledgements
+
+The API design and implementation of this gem is greatly inspired by [test-unit](https://github.com/test-unit/test-unit). Thank the great work.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/mrubyc/mrubyc-test. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "mrubyc/test"
+require "mrubyc-test"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/mrubyc/test/config.rb

@@ -8,21 +8,31 @@ module Mrubyc
     class Config
       class << self
         def read(check: true)
-          FileUtils.touch('.mrubycconfig')
-          config = YAML.load_file('.mrubycconfig')
+          config = YAML.load_file(mrubycfile)
           if check
             if !config || config == [] || !config['test_dir']
-              raise 'Check if `.mrubycconfig` exists.'
+              raise 'Check if `Mrubycfile or .mrubycconfig` exists.'
             end
           end
           config || {}
         end
 
         def write(config)
-          File.open('.mrubycconfig', 'r+') do |file|
+          File.open(mrubycfile, 'r+') do |file|
             file.write(config.to_yaml)
           end
         end
+
+        def mrubycfile
+          if File.exists? 'Mrubycfile'
+            'Mrubycfile'
+          elsif  File.exists? '.mrubycconfig'
+            '.mrubycconfig'
+          else
+            FileUtils.touch 'Mrubycfile'
+            'Mrubycfile'
+          end
+        end
       end
     end
   end

data/lib/mrubyc/test/generator/attribute.rb

@@ -10,14 +10,19 @@ module Mrubyc
           def run(model_files: [], test_files:)
             # get information from model files(application code)
             model_files.each do |model_file|
+              puts "loading #{model_file}"
               load model_file
               class_name = File.basename(model_file, '.rb').camelize
-              begin
-                model_class = Module.const_get(class_name)
-              rescue NameError => e
+              model_class = if Module.const_defined?(class_name)
+                Module.const_get(class_name)
+              elsif Module.const_defined?(class_name.upcase)
+                Module.const_get(class_name.upcase)
+              end
+              unless model_class
                 print "\e[33m"
                 puts "[WARN] #{model_file} doesn't have corresponding class `#{class_name}`."
                 print "\e[m"
+                next
               end
               model_class.class_eval do
                 def method_missing(_method_name, *_args)

data/lib/mrubyc/test/generator/double.rb

@@ -17,11 +17,13 @@ module Mrubyc
         end
 
         def method_missing(method_name, *args)
+          param_size = args[0] || 0
           @@double_method_locations << {
             type: @type,
             class: @klass,
             method_name: method_name,
             args: args.to_s,
+            method_parameters: Array.new(param_size).map.with_index{|_, i| ('a'.ord + i).chr }.join(','),
             block: (block_given? ? yield : nil),
             label: @location.label,
             path: @location.absolute_path || @location.path,

data/lib/mrubyc/test/generator/script.rb

@@ -10,11 +10,25 @@ module Mrubyc
         class << self
           def run(model_files: [], test_files:, test_cases:, verbose:, method_name_pattern:)
             config = Mrubyc::Test::Config.read
-            test_erb = ERB.new(File.read(File.expand_path('../../../../templates/test.rb.erb', __FILE__)), nil, '-')
-            models_erb = ERB.new(File.read(File.expand_path('../../../../templates/models.rb.erb', __FILE__)), nil, '-')
+            test_erb = ERB.new(
+              File.read(
+                File.expand_path('../../../../templates/test.rb.erb', __FILE__)
+              ), nil, '-'
+            )
+            models_erb = ERB.new(
+              File.read(
+                File.expand_path('../../../../templates/models.rb.erb', __FILE__)
+              ), nil, '-'
+            )
             mrubyc_class_dir = File.expand_path('../../../../mrubyc-ext/', __FILE__)
-            File.write(File.join(config['test_tmp_dir'], 'test.rb'), Rufo.format(test_erb.result(binding)))
-            File.write(File.join(config['test_tmp_dir'], 'models.rb'), Rufo.format(models_erb.result(binding)))
+            File.write(File.join(
+              config['test_tmp_dir'], 'test.rb'),
+              Rufo.format(test_erb.result(binding))
+            )
+            File.write(File.join(
+              config['test_tmp_dir'], 'models.rb'),
+              Rufo.format(models_erb.result(binding))
+            )
           end
         end
       end

data/lib/mrubyc/test/generator/test_case.rb

@@ -31,6 +31,7 @@ module Mrubyc
                         instance_variables: nil, # TODO
                         method_name: double[:method_name].to_s,
                         args: double[:args],
+                        method_parameters: double[:method_parameters],
                         return_value: double[:block],
                         line: double[:line]
                       }

data/lib/mrubyc/test/init.rb

@@ -11,12 +11,12 @@ module Mrubyc
           puts 'Initializing...'
           puts
 
-          puts '  touch .mrubycconfig'
+          puts '  touch Mrubycfile'
           config = Mrubyc::Test::Config.read(check: false)
           config['test_dir'] = 'test'
           config['test_tmp_dir'] = 'test/tmp'
           config['mruby_lib_dir'] = 'mrblib'
-          puts '  add config to .mrubycconfig'
+          puts '  add config to Mrubycfile'
           Mrubyc::Test::Config.write(config)
 
           hal_dir = "#{config['test_tmp_dir']}/hal"

data/lib/mrubyc/test/version.rb

@@ -1,5 +1,5 @@
 module Mrubyc
   module Test
-    VERSION = "0.5.3"
+    VERSION = "0.7.0-rc1"
   end
 end

data/lib/mrubyc-ext/mrubyc_test_case.rb

@@ -86,9 +86,9 @@ class MrubycTestCase
     end
   end
 
-  def self.description(text)
+  def description(text)
   end
-  def self.desc(text)
+  def desc(text)
   end
   def setup
   end

data/lib/mrubyc-ext/object.rb

@@ -16,8 +16,8 @@ class Object
       'Array'
     when FalseClass
       'FalseClass'
-    when Fixnum
-      'Fixnum'
+    when Integer
+      'Integer'
     when Float
       'Float'
     when Hash

data/lib/mrubyc-test.rb

@@ -25,30 +25,30 @@ module Mrubyc::Test
       def prepare(test_files, verbose, method_name_pattern)
         config = Mrubyc::Test::Config.read
         model_files = Dir.glob(File.join(Dir.pwd, config['mruby_lib_dir'], 'models', '*.rb'))
-
         # gather attributes from your implementations and tests
-        attributes = Mrubyc::Test::Generator::Attribute.run(model_files: model_files, test_files: test_files)
-
+        attributes = Mrubyc::Test::Generator::Attribute.run(
+          model_files: model_files,
+          test_files: test_files
+        )
         # convert attributes into tast_cases
         test_cases = Mrubyc::Test::Generator::TestCase.run(attributes)
-
         # generate a ruby script that will be compiled by mrbc and executed in mruby/c VM
-        Mrubyc::Test::Generator::Script.run(model_files: model_files, test_files: test_files, test_cases: test_cases, verbose: verbose, method_name_pattern: method_name_pattern)
+        Mrubyc::Test::Generator::Script.run(
+          model_files: model_files,
+          test_files: test_files,
+          test_cases: test_cases,
+          verbose: verbose,
+          method_name_pattern: method_name_pattern
+        )
       end
 
-      def make
+      def make(mrbc_path)
         config = Mrubyc::Test::Config.read
         tmp_dir = File.join(Dir.pwd, config['test_tmp_dir'])
         puts "cd #{tmp_dir}"
         puts
         exit_code = 0
         pwd = Dir.pwd
-        mruby_version = File.read('.ruby-version').gsub("\n", '').chomp
-        unless mruby_version.index('mruby')
-          puts '.ruby-version doesn\'t set `mruby-x.x.x It is recommended to use the latest version of https://github.com/hasumikin/mrubyc-utils`'
-          print 'You can specify the version name of mruby [mruby-x.x.x]: '
-          mruby_version = STDIN.gets.chomp
-        end
         hal_path = "#{pwd}/#{config['mrubyc_src_dir']}/hal"
         hal_bak_path = "#{pwd}/#{config['mrubyc_src_dir']}/~hal"
         FileUtils.mv(hal_path, hal_bak_path) if FileTest.exist?(hal_path)
@@ -56,9 +56,9 @@ module Mrubyc::Test
           FileUtils.ln_s "#{pwd}/#{config['test_tmp_dir']}/hal", "#{pwd}/#{config['mrubyc_src_dir']}/hal"
           Dir.chdir(tmp_dir) do
             [
-             "RBENV_VERSION=#{mruby_version} mrbc -E -B test test.rb",
-             "RBENV_VERSION=#{mruby_version} mrbc -E -B models models.rb",
-             "cc -I #{pwd}/#{config['mrubyc_src_dir']} -o test main.c #{pwd}/#{config['mrubyc_src_dir']}/*.c #{pwd}/#{config['mrubyc_src_dir']}/hal/*.c #{ENV["CFLAGS"]} #{ENV["LDFLAGS"]}",
+             "#{mrbc_path} -B test test.rb",
+             "#{mrbc_path} -B models models.rb",
+             "cc -O0 -g3 -Wall -I #{pwd}/#{config['mrubyc_src_dir']} -o test main.c #{pwd}/#{config['mrubyc_src_dir']}/*.c #{pwd}/#{config['mrubyc_src_dir']}/hal/*.c -DMRBC_USE_HAL_POSIX #{ENV["CFLAGS"]} #{ENV["LDFLAGS"]}",
              "./test"].each do |cmd|
                puts cmd
                puts
@@ -84,21 +84,57 @@ module Mrubyc::Test
 
     end
 
-    desc 'test', '[Default command] Execute test. You can specify a test file like `mrubyc-test test test/array_test.rb`'
-    option :every, type: :numeric, default: 10, aliases: "-e", banner: "NUMBER - To avoid Out of Memory, test will be devided up to every specified NUMBER of xxx_test.rb files"
-    option :verbose, type: :boolean, default: false, aliases: "-v", banner: "[true/false] - Show test result verbosely"
-    option :name, type: :string, aliases: "-n", banner: "NAME - Specify the NAME of tests you want to run. If you write --name='/PATTERN/', it will be processed as a regular expression. It must be single-quoted and doubled-backslash. eg) --name='/a\\\\db/' will create Regexp object `/a\\db/` and match strings like `a1b`"
+    desc 'test', <<~DESC
+      [Default command]
+      Execute test. You can specify a test file like
+      `mrubyc-test test test/array_test.rb`'
+    DESC
+    option :every, type: :numeric, default: 10, aliases: "-e",
+      banner: <<~DESC.chomp
+        NUMBER
+               To avoid Out of Memory, test will be devided up to
+               every specified NUMBER of xxx_test.rb files
+      DESC
+    option :verbose, type: :boolean, default: false, aliases: "-v",
+      banner: "[true/false] - Show test result verbosely"
+    option :name, type: :string, aliases: "-n",
+      banner: <<~DESC.chomp
+        NAME
+               Specify the NAME of tests you want to run. If you
+               write --name='/PATTERN/', it will be processed as a regular
+               expression. It must be single-quoted and doubled-backslash.
+               eg) --name='/a\\\\db/' will create Regexp object `/a\\db/`
+                   and match strings like `a1b`
+      DESC
+    option :mrbc_path, type: :string, aliases: "-p",
+      banner: <<~DESC.chomp
+        PATH
+               Specify the path to mrbc.
+               eg: /home/hoge/mruby/build/host/bin/mrbc
+               RBENV_VERSION will be ignored if you specify this option.
+      DESC
     def test(testfilepath = "test/*.rb")
       init_env
+      config = Mrubyc::Test::Config.read
       method_name_pattern = (%r{\A/(.*)/\Z} =~ options[:name] ? Regexp.new($1) : options[:name])
       test_path = if testfilepath == ""
         File.join(Dir.pwd, config['test_dir'], "*.rb")
       else
         File.join(Dir.pwd, testfilepath)
       end
+      mrbc_path = options[:mrbc_path] || config['mrbc_path']
+      unless mrbc_path
+        mruby_version = File.read('.ruby-version').gsub("\n", '').chomp
+        unless mruby_version.index('mruby')
+          puts '.ruby-version doesn\'t set `mruby-x.x.x It is recommended to use the latest version of https://github.com/hasumikin/mrubyc-utils`'
+          print 'You can specify the version name of mruby [mruby-x.x.x]: '
+          mruby_version = STDIN.gets.chomp
+        end
+        "RBENV_VERSION=#{mruby_version} mrbc"
+      end
       Dir.glob(test_path).each_slice(options[:every]) do |test_files|
         prepare(test_files, options[:verbose], method_name_pattern)
-        make
+        make(mrbc_path)
       end
     end
 

data/lib/templates/main.c.erb

@@ -4,19 +4,37 @@
 #include "models.c"
 #include "test.c"
 
-#define MEMORY_SIZE (1024*64)-1
+#define MEMORY_SIZE (1024*640)-1
 static uint8_t my_memory_pool[MEMORY_SIZE];
 
-int exit_code;
+int exit_code = 0;
 
-static void c_exit(mrb_vm *vm, mrb_value *v, int argc){
+static void c_exit(struct VM *vm, mrbc_value v[], int argc)
+{
   exit_code = GET_INT_ARG(1);
 }
 
+//================================================================
+/*! Object#instance_variable_get
+*/
+static void c_instance_variable_get(struct VM *vm, mrbc_value v[], int argc)
+{
+  mrbc_kv_handle *kvh = &v[0].instance->ivar;
+  const char *name = (const char *)GET_STRING_ARG(1);
+  for(int i = 0; i < kvh->n_stored; i++) {
+    if (strncmp(&name[1], symid_to_str(kvh->data[i].sym_id), strlen(name) - 1) == 0) {
+      SET_RETURN(kvh->data[i].value);
+      return;
+    }
+  }
+  SET_NIL_RETURN();
+}
+
 //================================================================
 /*! DEBUG PRINT
 */
-static void c_debugprint(mrb_vm *vm, mrb_value *v, int argc){
+static void c_debugprint(struct VM *vm, mrbc_value v[], int argc)
+{
   console_putchar('\n');
   for( int i = 0; i < 79; i++ ) { console_putchar('='); }
   console_putchar('\n');
@@ -34,6 +52,7 @@ int main(void) {
   mrbc_init(my_memory_pool, MEMORY_SIZE);
   mrbc_define_method(0, mrbc_class_object, "debugprint", c_debugprint);
   mrbc_define_method(0, mrbc_class_object, "exit", c_exit);
+  mrbc_define_method(0, mrbc_class_object, "instance_variable_get", c_instance_variable_get);
   mrbc_create_task( models, 0 );
   mrbc_create_task( test, 0 );
   mrbc_run();

data/lib/templates/test.rb.erb

@@ -7,7 +7,7 @@
 # For more information, see <%= Gem.loaded_specs['mrubyc-test']&.homepage %>
 #
 
-if RUBY_VERSION == '1.9' && MRUBYC_VERSION
+if RUBY_ENGINE == 'mruby/c'
   class Math
   end
   class Numeric
@@ -108,7 +108,7 @@ end
   <% end -%>
   <% test_case[:mocks].each do |mock| -%>
     class <%= mock[:class_name] %>
-      def <%= mock[:method_name] %>
+      def <%= mock[:method_name] %>(<%= mock[:method_parameters] %>)
         $mock.actual.add_by_key :<%= mock[:method_name] %>
       end
     end
@@ -126,7 +126,7 @@ end
     end
     <% test_case[:mocks].each do |mock| -%>
       class <%= mock[:class_name] %>Double
-        def <%= mock[:method_name] %>
+        def <%= mock[:method_name] %>(_param_size = 0)
           $mock.expected.add_by_key :<%= mock[:method_name] %>
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mrubyc-test
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.7.0.pre.rc1
 platform: ruby
 authors:
 - HASUMI Hitoshi
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-27 00:00:00.000000000 Z
+date: 2021-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,7 +137,7 @@ homepage: https://github.com/mrubyc/mrubyc-test
 licenses:
 - BSD-3-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,12 +148,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.17
+signing_key:
 specification_version: 4
 summary: Test Framework for mruby/c
 test_files: []