gamefic-sdk 3.0.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d90eb96a94149551b573259fd78410c1f0332b0a5ecaa9d559cc091a8962629
-  data.tar.gz: 4547e88ec7f62bcbe08d60d6411461327d1ff9f27c50755c47135c98cb4b1806
+  metadata.gz: 4b98f8d00bed8b7baaadddfceade62d8974c805e425e63b174f335bb0baa1874
+  data.tar.gz: f9b74e8df206e6b648316a06c4a9481873af3acade70a6d15a1cec794d216fcb
 SHA512:
-  metadata.gz: '01081048d9c32716574e9ff9d906ee03cf07259875d608ea36fb73bea310440d43760c4d12f8e33159dfc346b31a33bf5eabf50c042c06bb169204aa5f8d98c4'
-  data.tar.gz: 6fadb23c6b9cfeeb855bfb082a932ae6abde7c722ebb194d20b3902900d8c50b679ce52e4205a04d6ac7544386e8c41baa47587d7323f9cfa9157ff43c8ea8f1
+  metadata.gz: 36e1db4ce3268b0e86fa3a20f30a91b339d31a092ef8f598a23ea7bfbffd0cbbca6403032cad866d1d7f5a5d04560ed5013331656890346674204e9d7842bfdb
+  data.tar.gz: fbcd4fe1d2f68fdd64540d725cbee8d107ed9d17817fdc6abc3bd93d3a961951f2dfcb69150b8ecbd42f14e2d30e272f188fd0b23295debb3d99c42981867368

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 3.2.0 - July 20, 2024
+- Optional specs in project scaffold
+- Reorganize project requirements
+
+## 3.1.0 - July 13, 2024
+- Plot and Subplot classes in scaffold
+- Scaffold requires ostruct
+- Support for lib path in web project
+
 ## 3.0.1 - April 10, 2024
 - Updates to README in project scaffold
 

data/gamefic-sdk.gemspec

@@ -1,42 +1,46 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gamefic-sdk/version'
 require 'date'
 
-Gem::Specification.new do |s|
-  s.name          = 'gamefic-sdk'
-  s.version       = Gamefic::Sdk::VERSION
-  s.date          = Date.today.strftime("%Y-%m-%d")
-  s.summary       = "Gamefic SDK"
-  s.description   = "Development and command-line tools for Gamefic"
-  s.authors       = ["Fred Snyder"]
-  s.email         = 'fsnyder@gamefic.com'
-  s.homepage      = 'http://gamefic.com'
-  s.license       = 'MIT'
+Gem::Specification.new do |spec|
+  spec.name          = 'gamefic-sdk'
+  spec.version       = Gamefic::Sdk::VERSION
+  spec.date          = Date.today.strftime('%Y-%m-%d')
+  spec.summary       = 'Gamefic SDK'
+  spec.description   = 'Development and command-line tools for Gamefic'
+  spec.authors       = ['Fred Snyder']
+  spec.email         = 'fsnyder@gamefic.com'
+  spec.homepage      = 'https://gamefic.com'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = 'https://gamefic.com'
+  spec.metadata['source_code_uri'] = 'https://github.com/castwide/gamefic-sdk'
+  spec.metadata['changelog_uri'] = 'https://github.com/castwide/gamefic-sdk/blob/master/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  s.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|examples|guides)/}) }
   end
-  s.executables   = ['gamefic']
-  s.require_paths = ['lib']
+  spec.executables   = ['gamefic']
+  spec.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 2.7.0'
+  spec.required_ruby_version = '>= 2.7.0'
 
-  s.add_runtime_dependency 'gamefic', '~> 3.0'
-  s.add_runtime_dependency 'gamefic-standard', '~> 3.0'
-  s.add_runtime_dependency 'gamefic-tty', '~> 3.0'
-  s.add_runtime_dependency 'listen', '~> 3.0'
-  s.add_runtime_dependency 'opal', '~> 1.1'
-  s.add_runtime_dependency 'puma', '~> 6'
-  s.add_runtime_dependency 'sinatra', '~> 2'
-  s.add_runtime_dependency 'thor', '~> 1.0'
+  spec.add_runtime_dependency 'gamefic', '~> 3.0'
+  spec.add_runtime_dependency 'gamefic-standard', '~> 3.0'
+  spec.add_runtime_dependency 'gamefic-tty', '~> 3.0'
+  spec.add_runtime_dependency 'listen', '~> 3.0'
+  spec.add_runtime_dependency 'opal', '~> 1.1'
+  spec.add_runtime_dependency 'puma', '~> 6'
+  spec.add_runtime_dependency 'sinatra', '~> 2'
+  spec.add_runtime_dependency 'thor', '~> 1.0'
 
-  s.add_development_dependency 'bundler', '~> 2.0'
-  s.add_development_dependency 'capybara', '~> 3.3'
-  s.add_development_dependency 'rake', '~> 13.0'
-  s.add_development_dependency 'rspec', '~> 3.0'
-  s.add_development_dependency 'selenium-webdriver', '~> 4.2'
-  s.add_development_dependency 'simplecov', '~> 0.14'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'capybara', '~> 3.3'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'selenium-webdriver', '~> 4.2'
+  spec.add_development_dependency 'simplecov', '~> 0.14'
 end

data/lib/gamefic-sdk/scaffold.rb

@@ -1,5 +1,7 @@
-require 'fileutils'
+require 'bundler'
 require 'erb'
+require 'fileutils'
+require 'ostruct'
 require 'pathname'
 require 'securerandom'
 require 'shellwords'
@@ -25,28 +27,33 @@ module Gamefic
 
       def render(file, data)
         template = File.read(file)
-        erb = ERB.new(template)
+        erb = ERB.new(template, trim_mode: '-')
         erb.result(data.get_binding)
       end
 
       def custom_copy origin, destination, data
         FileUtils.mkdir_p File.dirname(destination)
         if origin.end_with?('.gf.erb')
-          File.write destination[0..-8], render(origin, data)
+          content = render(origin, data)
+          return if content.empty?
+
+          File.write destination[0..-8], content
         else
           FileUtils.cp_r origin, destination
         end
       end
 
-      def build name, destination
+      def build name, destination, **opts
         dir = File.join(SCAFFOLDS_PATH, name)
         raise LoadError, "Scaffold `#{name}` does not exist" unless File.directory?(dir)
 
         path = Pathname.new('.').join(destination).realdirpath
-        data = Binder.new(name: File.basename(path))
+        data = Binder.new(name: File.basename(path), **opts)
         files = Dir.glob(File.join(dir, '**', '*'), File::FNM_DOTMATCH).select { |entry| File.file?(entry) }
         map = {}
         files.each do |file|
+          next if file.include?('/spec') && !opts[:specs]
+
           rename = File.join(File.dirname(file), File.basename(file)).gsub('__name__', data.name)
           dst = File.join(destination, rename[dir.length..-1])
           raise "Gamefic generation would overwrite existing file #{rename}" if File.file?(dst)
@@ -54,7 +61,9 @@ module Gamefic
           map[file] = dst
         end
         map.each_pair { |src, dst| custom_copy src, dst, data }
-        system "cd #{Shellwords.escape(destination)} && bundle install"
+        Bundler.with_unbundled_env do
+          Dir.chdir(path) { system 'bundle install' }
+        end
       end
     end
   end

data/lib/gamefic-sdk/shell.rb

@@ -14,9 +14,10 @@ module Gamefic
 
       desc 'init DIRECTORY_NAME', 'Create a new project in DIRECTORY_NAME'
       option :gem, type: :boolean, aliases: [:g, :library, :rubygem], desc: 'Make a gem project'
+      option :specs, type: :boolean, desc: 'Add RSpec and Opal::RSpec test suites', default: true
       def init(directory_name)
         scaffold = options[:gem] ? 'library' : 'project'
-        Gamefic::Sdk::Scaffold.build scaffold, directory_name
+        Gamefic::Sdk::Scaffold.build scaffold, directory_name, specs: options[:specs]
         puts "Gamefic project initialized at #{File.realpath(directory_name)}"
       end
 

data/lib/gamefic-sdk/tasks/ruby.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'gamefic-tty'
 require 'tmpdir'
 require 'zlib'

data/lib/gamefic-sdk/tasks/web.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'listen'
 
 module Gamefic
@@ -16,7 +18,7 @@ module Gamefic
           FileUtils.mkdir_p web_path
           Dir.chdir web_path do
             name = File.basename(absolute_path)
-            system 'npx', 'react-gamefic', '--name', name, '--class', 'GAMEFIC_PLOT_CLASS'
+            system 'npx', 'react-gamefic', '--name', name, '--class', 'GAMEFIC_PLOT_CLASS', '--path', '../lib'
             puts 'The web app is ready.'
             puts 'Run `rake web:run` to start the app in dev mode.'
           end

data/lib/gamefic-sdk/version.rb

@@ -2,6 +2,6 @@
 
 module Gamefic
   module Sdk
-    VERSION = '3.0.1'
+    VERSION = '3.2.0'
   end
 end

data/scaffolds/project/.gitignore

@@ -1,2 +1,4 @@
-builds
-node_modules
+/coverage
+/ruby/build
+/web/build
+/web/node_modules

data/scaffolds/project/.rspec.gf.erb

@@ -0,0 +1,4 @@
+<% if specs %>
+--color
+--require spec_helper
+<% end %>

data/scaffolds/project/{Gemfile → Gemfile.gf.erb}

@@ -8,5 +8,13 @@ gem 'gamefic-standard'
 group :development do
   gem 'gamefic-sdk'
   gem 'gamefic-tty'
+<% if specs -%>
+  gem 'opal-rspec'
+  gem 'opal-sprockets'
+<% end -%>
   gem 'rake'
+<% if specs -%>
+  gem 'rspec'
+  gem 'simplecov'
+<% end -%>
 end

data/scaffolds/project/README.md.gf.erb

@@ -39,6 +39,18 @@ Open http://localhost:9000 in a browser.
 
 The application will be saved in the `web/build` directory.
 
+## Unit Tests
+
+To run the test suite with Ruby:
+
+    $ rspec
+
+To run the test suite with Opal:
+
+    $ rake opal
+
+The Opal tests can be useful for finding bugs in the web build that do not occur in standard Ruby.
+
 ## More Information
 
 Go to https://gamefic.com for documentation.

data/scaffolds/project/Rakefile.gf.erb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'bundler'
+require 'bundler/setup'
+require 'gamefic-sdk'
+require 'opal/rspec/rake_task'
+
+# Add the default Gamefic tasks for building and running games
+# Run `rake --tasks` for a list of commands and descriptions
+Gamefic::Sdk::Tasks.define_all
+<% if specs %>
+Opal::RSpec::RakeTask.new(:opal) do |_, config|
+  Bundler.definition
+         .dependencies_for([:default])
+         .each { |dep| Opal.use_gem dep.name }
+  Opal.append_path __dir__
+  Opal.append_path File.join(__dir__, 'lib')
+  config.pattern = 'spec/**/*_spec.rb'
+  config.requires = ['spec/opal_helper']
+end
+<% end %>

data/scaffolds/project/lib/__name__.rb.gf.erb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'gamefic'
+require 'gamefic-standard'
+
+module <%= camelcase(name) %>
+  require '<%= name %>/plot'
+  require '<%= name %>/subplot'
+end

data/scaffolds/project/main.rb.gf.erb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
-require 'gamefic'
-require 'gamefic-standard'
+lib = File.expand_path('./lib', File.dirname(__FILE__))
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require_relative '<%= name %>/plot'
-require_relative '<%= name %>/subplot'
+require '<%= name %>'
 
 # The Gamefic SDK uses this constant to select the main Plot for game engines.
 GAMEFIC_PLOT_CLASS = <%= camelcase(name) %>::Plot

data/scaffolds/project/spec/__name__/plot_spec.rb.gf.erb

@@ -0,0 +1,24 @@
+RSpec.describe <%= camelcase(name) %>::Plot do
+  let(:plot) { <%= camelcase(name) %>::Plot.new }
+
+  it 'gives all entities a description' do
+    undescribed = plot.entities
+                      .reject(&:has_description?)
+
+    expect(undescribed).to be_empty
+  end
+
+  it 'uniquely identifies entities by name' do
+    actor = plot.introduce
+
+    plot.entities.that_are(Openable).each { |entity| entity.open = true }
+
+    plot.entities.that_are(Room).each do |room|
+      actor.parent = room
+      plot.available.select(actor).each do |entity|
+        result = plot.available(ambiguous: true).query(actor, entity.name)
+        expect(result.match).to eq([entity])
+      end
+    end
+  end
+end

data/scaffolds/project/spec/__name__/subplot_spec.rb.gf.erb

@@ -0,0 +1,10 @@
+RSpec.describe <%= camelcase(name) %>::Subplot do
+  let(:plot) { <%= camelcase(name) %>::Plot.new }
+
+  it 'branches from plots' do
+    actor = plot.introduce
+    subplot = plot.branch(<%= camelcase(name) %>::Subplot, introduce: actor)
+    expect(plot.subplots).to eq([subplot])
+    expect(subplot.players).to eq([actor])
+  end
+end

data/scaffolds/project/spec/gameplay_spec.rb

@@ -0,0 +1,21 @@
+RSpec.describe 'gameplay' do
+  let(:plot) { GAMEFIC_PLOT_CLASS.new }
+
+  let(:commands) do
+    # Customize this array of commands to reach a conclusion
+    [
+      'look around'
+    ]
+  end
+
+  it 'reaches a conclusion' do
+    player = plot.introduce
+    player.queue.concat commands
+    plot.ready
+    until player.queue.empty?
+      plot.update
+      plot.ready
+    end
+    expect(plot).to be_concluding
+  end
+end

data/scaffolds/project/spec/opal_helper.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'shared_helper'

data/scaffolds/project/spec/shared_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative '../main'
+
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  # Kernel.srand config.seed
+end

data/scaffolds/project/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+SimpleCov.start
+require_relative 'shared_helper'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamefic-sdk
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-10 00:00:00.000000000 Z
+date: 2024-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gamefic
@@ -242,16 +242,27 @@ files:
 - scaffolds/library/lib/__name__.rb.gf.erb
 - scaffolds/library/lib/__name__/version.rb.gf.erb
 - scaffolds/project/.gitignore
-- scaffolds/project/Gemfile
+- scaffolds/project/.rspec.gf.erb
+- scaffolds/project/Gemfile.gf.erb
 - scaffolds/project/README.md.gf.erb
-- scaffolds/project/Rakefile
-- scaffolds/project/__name__/plot.rb.gf.erb
-- scaffolds/project/__name__/subplot.rb.gf.erb
+- scaffolds/project/Rakefile.gf.erb
+- scaffolds/project/lib/__name__.rb.gf.erb
+- scaffolds/project/lib/__name__/plot.rb.gf.erb
+- scaffolds/project/lib/__name__/subplot.rb.gf.erb
 - scaffolds/project/main.rb.gf.erb
-homepage: http://gamefic.com
+- scaffolds/project/spec/__name__/plot_spec.rb.gf.erb
+- scaffolds/project/spec/__name__/subplot_spec.rb.gf.erb
+- scaffolds/project/spec/gameplay_spec.rb
+- scaffolds/project/spec/opal_helper.rb
+- scaffolds/project/spec/shared_helper.rb
+- scaffolds/project/spec/spec_helper.rb
+homepage: https://gamefic.com
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://gamefic.com
+  source_code_uri: https://github.com/castwide/gamefic-sdk
+  changelog_uri: https://github.com/castwide/gamefic-sdk/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:

data/scaffolds/project/Rakefile

@@ -1,6 +0,0 @@
-require 'bundler/setup'
-require 'gamefic-sdk'
-
-# Add the default Gamefic tasks for building and running games
-# Run `rake --tasks` for a list of commands and descriptions
-Gamefic::Sdk::Tasks.define_all