satisfactory 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bb15c794b5397907577dbe90ac97815f6636d7c0268db9c553a91a2b51b1a56
-  data.tar.gz: 84336045dedaea44be72e4bd3a108624af18986b8d7cc7b5a07381b3910620c0
+  metadata.gz: 5f92a6520f9da8ca43a99ca37697bfc84c56ae52f78a35bab4b8b74a2c369bb0
+  data.tar.gz: ddf946cf48f563c8153ce34410e2bbf4dc625d4b7f455fed4dc06d8d11188d63
 SHA512:
-  metadata.gz: e018c58477288a2eac77a10889d31ba5a3c20b4c4c280d248789693d2c115849f88e42b7a759d471e8eadd4d46a079cb5496910248bb99a3f158bc420fb62d9b
-  data.tar.gz: bd5b099abce2a3d5b051a4c0e3343710d1305db4aa00a7b5c7e6a4c8614f84570afec990f86fe1d0c41228d803fd3db5bd61f1faaef9b2302e94e8fc4640573a
+  metadata.gz: 59fba38663b4c69a4e3689a6122d6ad6a99f78ec9d4102a8242c23fe216dc554a6ba8ac6eb69aad6402eba42e6bb530989a26e1317ea1c602a0fad0259432583
+  data.tar.gz: aa609786510b01445fce671750ec1a713fe2312fe555cc449761a727ee15197ff7d3248153cdbd9a492dfa4a178a380353ea5f713ab4490c134f1cbca1275f84

data/lib/satisfactory/record.rb

@@ -65,6 +65,14 @@ module Satisfactory
       end
     end
 
+    # Same as {#with} but always creates a new record.
+    #
+    # @param (see #and)
+    # @return (see #with)
+    def with_new(count = nil, downstream_type, **attributes) # rubocop:disable Style/OptionalArguments
+      with(count, downstream_type, force: true, **attributes)
+    end
+
     # Add a sibling record to the parent record's build plan.
     # e.g. adding a second user to a project.
     #
@@ -78,7 +86,7 @@ module Satisfactory
 
     # Apply one or more traits to this record's build plan.
     #
-    # @param *traits [Symbol, ...] The traits to apply.
+    # @param traits [Symbol, ...] The traits to apply.
     def which_is(*traits)
       traits.each { |trait| self.traits << trait }
       self
@@ -91,11 +99,7 @@ module Satisfactory
     def and_same(upstream_type)
       Satisfactory::UpstreamRecordFinder.new(upstream:).find(upstream_type)
     end
-
-    # @api private
-    def modify
-      yield(self).upstream
-    end
+    alias return_to and_same
 
     # Trigger the creation of this tree's build plan.
     #

data/lib/satisfactory/root.rb

@@ -43,5 +43,8 @@ module Satisfactory
     def upstream
       nil
     end
+
+    # @api private
+    class FactoryNotDefinedError < StandardError; end
   end
 end

data/lib/satisfactory/upstream_record_finder.rb

@@ -7,8 +7,24 @@ module Satisfactory
       @upstream = upstream
     end
 
+    # @api private
     attr_accessor :upstream
 
+    # @!method create
+    #   Delegates to the upstream record.
+    #   @return (see Satisfactory::Record#create)
+    #   @see Satisfactory::Record#create
+    # @!method with_new
+    #   Delegates to the upstream record.
+    #   @return (see Satisfactory::Record#with_new)
+    #   @see Satisfactory::Record#with_new
+    delegate :create, :with_new, to: :upstream
+
+    # Find the upstream record of the given type.
+    #
+    # @api private
+    # @param type [Symbol] The type of upstream record to find.
+    # @return [Satisfactory::Record, Satisfactory::Collection, Satisfactory::Root]
     def find(type)
       raise MissingUpstreamRecordError, type if upstream.nil?
 
@@ -20,6 +36,7 @@ module Satisfactory
       end
     end
 
+    # (see Satisfactory::Record#with)
     def with(*args, **kwargs)
       upstream.with(*args, force: true, **kwargs)
     end

data/lib/satisfactory/version.rb

@@ -1,3 +1,3 @@
 module Satisfactory
-  VERSION = "0.2.0".freeze
+  VERSION = "0.3.0".freeze
 end

data/satisfactory.gemspec

@@ -19,21 +19,15 @@ Gem::Specification.new do |spec|
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) {
     Dir[
-      "{bin,lib}/**/*",
+      "lib/**/*",
       "CHANGELOG.md",
       "LICENCE",
-      "Rakefile",
       "README.md",
       "satisfactory.gemspec",
     ]
   }
 
-  spec.bindir = "bin"
-  spec.executables = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "factory_bot_rails", "~> 6.2"
-
-  spec.add_development_dependency "rubocop", "~> 1.40"
-  spec.add_development_dependency "yard", "~> 0.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: satisfactory
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Elliot Crosby-McCullough
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-19 00:00:00.000000000 Z
+date: 2022-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
@@ -24,57 +24,16 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.2'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.40'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.40'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
 description:
 email:
 - elliot.cm@gmail.com
-executables:
-- console
-- rubocop
-- setup
-- yard
-- yardoc
-- yri
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENCE
 - README.md
-- Rakefile
-- bin/console
-- bin/rubocop
-- bin/setup
-- bin/yard
-- bin/yardoc
-- bin/yri
 - lib/satisfactory.rb
 - lib/satisfactory/collection.rb
 - lib/satisfactory/loader.rb
@@ -87,7 +46,7 @@ homepage: https://github.com/SmartCasual/satisfactory
 licenses:
 - CC-BY-NC-SA-4.0
 metadata:
-  changelog_uri: https://github.com/SmartCasual/satisfactory/blob/v0.2.0/CHANGELOG.md
+  changelog_uri: https://github.com/SmartCasual/satisfactory/blob/v0.3.0/CHANGELOG.md
   homepage_uri: https://github.com/SmartCasual/satisfactory
   source_code_uri: https://github.com/SmartCasual/satisfactory
   rubygems_mfa_required: 'true'

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: :rubocop

data/bin/console

@@ -1,13 +0,0 @@
-#!/usr/bin/env ruby
-require "bundler/setup"
-require "satisfactory"
-
-# 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.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/rubocop

@@ -1,27 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'rubocop' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
-
-bundle_binstub = File.expand_path("bundle", __dir__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("rubocop", "rubocop")

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/bin/yard

@@ -1,27 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'yard' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
-
-bundle_binstub = File.expand_path("bundle", __dir__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("yard", "yard")

data/bin/yardoc

@@ -1,27 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'yardoc' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
-
-bundle_binstub = File.expand_path("bundle", __dir__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("yard", "yardoc")

data/bin/yri

@@ -1,27 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'yri' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
-
-bundle_binstub = File.expand_path("bundle", __dir__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("yard", "yri")