assert_generator 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 65c081e83d976a9f0120deeedaa3d6ebb395784aa678d51cf12c5e81803a1baf
+  data.tar.gz: 6b3a772c932245b571b3dfdf1f22b49bfdb07f41faaa95f6860e54c5b4ace8a7
+SHA512:
+  metadata.gz: 631a95c52aee8e6446ec26b808db9a98a7104a0ed78bebe5913a76df2331144d9b034941409ece16b7d78920c4ff2a31f572ddd2d104ea36b49df7e369df3a29
+  data.tar.gz: 6ee2a4b51a2ef2d86fc69ee0849a61294b81dbc601d67c1463970524c3c714e903a43395bdf2c85e5b3507117fcd9013f59085e8a284e0c334ee99b732aa104c

data/lib/assert_generator.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module AssertGenerator
+  # Generate asserts based on some actual output from an object under test
+  # Outputs executable code to stdout with the assert statements, which can be pasted into the test
+  # The user needs to ensure that values are deterministic and do not change between test invocations
+  #
+  # @overload generate_asserts(source, source_expr)
+  #   Generate asserts for a source object supplying an expression to access that object,
+  #   e.g: `generate_asserts(res, 'res' )
+  #   @param source [Object] an object to generate asserts that the object contains the values as recorded
+  #     when this got called
+  #   @param source_expr [String] the source expression that created the object, will be repeated into the asserts
+  #
+  # @overload generate_asserts { block }
+  #   Generate asserts for a source object defined in a block - reflect the block to get the source to output
+  #     to access the object
+  #   @param relative_dates [String] adjust dates to be relative to the supplied date as a string expression
+  #     - use with date dependent fixtures
+  #   @yield a block which when evaluated returns the source object
+  #
+  def self.generate_asserts(source = nil, source_expr = nil, relative_dates: nil, &block)
+    AssertGenerator::Klass.new.send(:generate_asserts, source, source_expr, relative_dates, block)
+  end
+
+  class Klass
+    attr_accessor :relative_dates, :relative_date_today
+
+    def generate_asserts(source, source_expr, relative_dates, block)
+      if block
+        unless !defined?(Rails) || Rails.env.test?
+          raise 'AssertGenerator must only be used in the test context'
+        end
+
+        source_expr = block.call.to_s
+        # rubocop:disable Security/Eval
+        source ||= eval(source_expr, block.binding)
+        # rubocop:enable Security/Eval
+      end
+
+      unless source_expr
+        raise 'generate_asserts wants a source expression or a block'
+      end
+
+      if relative_dates
+        raise 'relative_dates needs block syntax' unless block
+
+        self.relative_dates = relative_dates
+        # rubocop:disable Security/Eval
+        self.relative_date_today = eval(relative_dates, block.binding)
+        # rubocop:enable Security/Eval
+      end
+
+      if source.is_a?(Hash)
+        generate_asserts_hash(source, source_expr)
+        return self
+      end
+
+      if defined?(ActiveRecord::Base) && source.is_a?(ActiveRecord::Base)
+        generate_asserts_ar(source, source_expr)
+        return self
+      end
+
+      if source.is_a?(Enumerable)
+        generate_asserts_enum(source, source_expr)
+        return self
+      end
+
+      generate_assert_drillable_item(source, ->(_c) { source_expr }, source)
+      self
+    end
+
+    def generate_asserts_ar(h, p)
+      h.attributes.each do |k, v|
+        generate_assert_drillable_item(v, ->(meth) { "#{p}.#{meth}" }, k)
+      end
+    end
+
+    def generate_asserts_hash(h, p)
+      h.each do |k, v|
+        generate_assert_drillable_item(v, ->(sym) { "#{p}[:#{sym}]" }, k)
+      end
+    end
+
+    def generate_asserts_enum(a, p)
+      generate_assert_drillable_item(a.count, ->(_c) { "#{p}.count" }, p)
+
+      a.each_with_index do |v, idx|
+        generate_assert_drillable_item(v, ->(index) { "#{p}[#{index}]" }, idx)
+      end
+    end
+
+    def generate_assert_drillable_item(v, make_accessor, *accessor_params)
+      accessor = make_accessor.call(*accessor_params)
+      if drillable_object(v)
+        generate_asserts(v, accessor, nil, nil)
+      else
+        if v.nil?
+          out "assert_nil #{accessor}"
+        elsif v.is_a?(true.class)
+          out "assert #{accessor}"
+        elsif v.is_a?(false.class)
+          out "refute #{accessor}"
+
+        elsif v.is_a?(DateTime) || (defined?(ActiveSupport::TimeWithZone) && v.is_a?(ActiveSupport::TimeWithZone))
+          generate_date_time_assert(v, accessor)
+        elsif v.is_a?(Date)
+          generate_date_assert(v, accessor)
+        else
+          out "assert_equal #{v.inspect}, #{make_accessor.call(*accessor_params)}"
+        end
+      end
+    end
+
+    def out(s)
+      puts(s)
+    end
+
+    def drillable_object(v)
+      v.is_a?(Enumerable) || (defined?(ActiveRecord::Base) && v.is_a?(ActiveRecord::Base))
+    end
+
+    def generate_date_assert(v, accessor)
+      if relative_dates
+        date_diff = v - relative_date_today
+        if date_diff.to_i == 0
+          out "assert_equal #{relative_dates}, #{accessor}"
+        else
+          out "assert_equal #{relative_dates} + #{date_diff}.days, #{accessor}"
+        end
+      else
+        out "assert_equal Date.new(#{v.year}, #{v.month}, #{v.day}), #{accessor}"
+      end
+    end
+
+    def generate_date_time_assert(v, accessor)
+      out "assert_equal DateTime.new(#{v.year}, #{v.month}, #{v.day}, " \
+             + "#{v.hour}, #{v.min}, #{v.sec}, '#{v.zone}'), #{accessor}"
+    end
+  end
+end

data/lib/assert_generator/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AssertGenerator
+  VERSION = '0.1.1'
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: assert_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Richard Parratt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.76'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.76'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+description: |
+  Generate assert code from a result inside a unit or integration test.
+  This is useful if you have code that you've spiked or eyeballed as 'working' and you'd like to produce some assertions,
+  without editing the output of pretty-inspect manually or making it all up.
+email:
+- richard.parratt@sharesight.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/assert_generator.rb
+- lib/assert_generator/version.rb
+homepage: 
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/sharesight/assert_generator
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: An assert generating gem.
+test_files: []