factory_strategist 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83f33524068913a52ed377f0ba677ddf8e669598a0d2a679ee939ee91d540120
-  data.tar.gz: 0c5b55ccc8d6799c2f46f3cdb30630aa68e60300104e9b4499dd5317c8e0e88a
+  metadata.gz: b07999650c6bcc6ae0df9f0bf95dcf750133bfd89749a42a3d41e369454c543a
+  data.tar.gz: 7d023e6035a66b3080a8d50fa76a25db8a545e1e88b7575366fbaa75b601c8b8
 SHA512:
-  metadata.gz: f65c98e670a0e64af242e1c7ba4bf4e3c4ebf16a08457bcad97bf657f1b311ecae196f758e9b03587161d6ff26e72dacdbec1147d328425362495284788af743
-  data.tar.gz: d545034207063763fcf086b92b2dccafa1aeaf1faf4ce736f31d6a50ff84341fa92b58ce551563c2b6284111761122248bbba777cb298380476ce565d7bae4bc
+  metadata.gz: 4c72a9e9712a09a5c93fcb81ccfcdcde921250d341deac535bb2d71bbaa07f517e42065ef664d4f153b15f09d06fbc6b35dd9abe390a319680cbf19079d7d366
+  data.tar.gz: 406c76322557328fcce027c0caa62e600c3c2c0b87756cfd1572460953f8714211d1cebeb24d8393f3774b556bc2bb442fb4bee4a96233f1f90cd19613462ff9

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 ## [Unreleased]
 
+## [0.6.0] - 2021-10-23
+
+### Fixed
+
+- Fix env name, `FATORYSTRATEGIST` to `FACTORY_STRATEGIST` by @okuramasafumi
+
+## [0.5.0] - 2021-10-22
+
+### Changed
+
+- `build` now takes precedence over `build_stubbed`
+
+## [0.4.0] - 2021-10-20
+
+### Changed
+
+- Rewrite `create` to `build` or `build_stubbed` and create new example block
+
+## [0.3.0] - 2021-10-03
+
+- Rewrite main codes to make them simple(no specs!)
+
 ## [0.2.0] - 2021-09-26
 
 - Add environment variable: `FATORYSTRATEGIST` to apply configuration this gem expands

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    factory_strategist (0.1.0)
+    factory_strategist (0.6.0)
       factory_bot
       rspec
 
@@ -62,9 +62,10 @@ GEM
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
+  x86_64-darwin-19
   x86_64-darwin-20
   x86_64-linux
 
@@ -77,4 +78,4 @@ DEPENDENCIES
   rubocop-rspec
 
 BUNDLED WITH
-   2.2.26
+   2.2.28

data/README.md

@@ -21,16 +21,6 @@ Or install it yourself as:
 
     $ gem install factory_strategist
 
-At last, include module at in spec/rails_heper of your rails app:
-
-```ruby
-require 'factory_strategist'
-
-RSpec.configure do |config|
-  config.include FactoryStrategist
-end
-```
-
 ## Usage
 
 As for usability, it is like a kind of linter.
@@ -40,7 +30,7 @@ As for usability, it is like a kind of linter.
 When your application has `spec/models/user_spec.rb` and run it with FactoryStrategist.
 
 ```shell
-$ FATORYSTRATEGIST=1 bundle exec rspec spec/models/user_spec.rb
+$ FACTORY_STRATEGIST=1 bundle exec rspec spec/models/user_spec.rb
 ```
 
 In the case which you choose best strategies, the commands returns nothing.
@@ -58,7 +48,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/factory_strategist. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/factory_strategist/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/neko314/factory_strategist. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/neko314/factory_strategist/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -66,4 +56,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the FactoryStrategist project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/factory_strategist/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the FactoryStrategist project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/neko314/factory_strategist/blob/main/CODE_OF_CONDUCT.md).

data/lib/factory_strategist/configure.rb

@@ -2,22 +2,48 @@
 
 require "rspec"
 require "factory_bot"
+require_relative "./proc_parser"
+
+using ProcParser
 module FactoryStrategist
   # Settings to see which method is best
   module Configure
     RSpec.configure do |config|
-      config.before(:suite) do |_ex|
-        FactoryBot::Syntax::Methods.alias_method :create, :build_stubbed
-      end
-
-      config.after(:example) do |ex|
-        case ex.exception
-        when RSpec::Expectations::ExpectationNotMetError
-          # no-op
-        when nil
-          p "#{ex.location} create can be replaced to build_stubbed"
-        end
+      config.around(:example) do |ex|
+        detect_optimal_strategy_at(ex)
       end
     end
   end
 end
+
+private
+
+def detect_optimal_strategy_at(example)
+  return unless run_successfully?(example) # when spec fails with create, no-op
+
+  return put_best_strategy_at(example, :build) if run_successfully_with?("build", example)
+
+  put_best_strategy_at(example, :build_stubbed) if run_successfully_with?("build_stubbed", example)
+end
+
+def run_successfully?(example)
+  example.call
+  true
+rescue StandardError
+  false
+end
+
+def put_best_strategy_at(example, method)
+  p "#{example.location} create can be replaced to #{method}"
+end
+
+def run_successfully_with?(method_name, example)
+  ex = example_replaced_from_create_to(method_name, example)
+  run_successfully?(ex)
+end
+
+def example_replaced_from_create_to(method_name, example)
+  block_body = example.example.metadata[:block].body
+  new_body = "Proc.new{ #{block_body.gsub("create", method_name.to_s)} }"
+  eval(new_body) # rubocop:disable Security/Eval
+end

data/lib/factory_strategist/proc_parser.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# module to get parsed proc as string
+# the codes in this file are based on https://secret-garden.hatenablog.com/entry/2019/09/08/145037 by @osyo-manga
+module ProcParser
+  ELEMENTS = %i[
+    magic
+    major_version
+    minor_version
+    format_type
+    misc
+    label
+    path
+    absolute_path
+    first_lineno
+    type
+    locals
+    args
+    catch_table
+    bytecode
+  ].freeze
+
+  refine RubyVM::InstructionSequence do
+    def to_h
+      ELEMENTS.zip(to_a).to_h
+    end
+  end
+
+  using self
+
+  refine Proc do
+    def body # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      path, (start_lnum, start_col, end_lnum, end_col) = code_location
+
+      raise "Unsupported file" if path.nil?
+
+      File.readlines(path).then do |lines|
+        start_line = lines[start_lnum - 1]
+        end_line = lines[end_lnum - 1]
+        if start_lnum == end_lnum
+          start_line[(start_col + 1)...(end_col - 1)]
+        elsif end_lnum - start_lnum == 1
+          start_line[(start_col + 1)...] + end_line[...(end_col - 1)]
+        else
+          lines[start_lnum...(end_lnum - 1)].join
+        end
+      end
+    end
+
+    def code_location
+      RubyVM::InstructionSequence.of(self).to_h
+                                 .then { |iseq| [iseq[:absolute_path], iseq.dig(:misc, :code_location)] }
+    end
+  end
+end

data/lib/factory_strategist/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FactoryStrategist
-  VERSION = "0.2.0"
+  VERSION = "0.6.0"
 end

data/lib/factory_strategist.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
 require_relative "factory_strategist/version"
-require_relative "factory_strategist/configure" if ENV["FATORYSTRATEGIST"]
+require_relative "factory_strategist/configure" if ENV["FACTORY_STRATEGIST"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factory_strategist
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Keiko Kaneko
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-26 00:00:00.000000000 Z
+date: 2021-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot
@@ -89,6 +89,7 @@ files:
 - factory_strategist.gemspec
 - lib/factory_strategist.rb
 - lib/factory_strategist/configure.rb
+- lib/factory_strategist/proc_parser.rb
 - lib/factory_strategist/version.rb
 homepage: https://github.com/neko314/factory_strategist
 licenses: