gamefic-sdk 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f10176e643c4b2c2d6cfaab7cc0e9ef02b5e1d2611663c3722b22fd26f8a19ff
-  data.tar.gz: 8337ecbafa9ddfc546f1002bf176f507447640429ea110c96b544c046e52c205
+  metadata.gz: 76da51db81b6dc52df2c2c5e845f778ff9a9d71154f707b19ae387f391b8e6b2
+  data.tar.gz: 2ac813718878085ddf4480afea7b833aba67bf4f090729719d06b03f322a17ac
 SHA512:
-  metadata.gz: 7e89c8edd366ac6e4a36b9edfa5bf7240ff344297e6ccfcef105ee92c3ee4f7ce7ac771498f32cf2bbdc69562a292bd1b4de9eeecc9ea3e06e54d0a646130ccb
-  data.tar.gz: 241fbc39235327f6e03aefb68955650a73f17508212f5482ebb9bdaebb82e449fefd0aeb4f04198054aad49ea07505c2f080f4e3a526e3b6e22645803c22e6b8
+  metadata.gz: 59fdb821c8e7fc454182c69b91bc9915b0086e4aaa2048de90c22b5cbf74c62ef216a7ca25a972e3c1786170ed1c5a1ca46fac668bb6ebf9eeff6c0aade26f07
+  data.tar.gz: 6646a38f8a8bd6dcf0c50fccc48cdad108adf5122a2c6a047ecc1ae675d95d5ce1d6f3a153df72b0962c322e9b9973e60e9fb7536a9e7c37e4095686e5f9006e

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 2.4.0 - September 9, 2021
+- Update dependencies
+- README template formatting
+- Fix /restore in development server
+
+## 2.3.3 - July 3, 2021
+- Rename READMEs in scaffolds so they get rendered
+- Update gamefic dependency
+- Fix bundle install in scaffold build
+
+## 2.3.2 - March 11, 2021
+- Add READMEs to project scaffolds
+- Disable css-loader esModule option in webpack config
+
+## 2.3.1 - March 3, 2021
+- Update opal dependency
+
 ## 2.3.0 - December 14, 2020
 - Update package dependencies for web builds
 

data/gamefic-sdk.gemspec

@@ -24,17 +24,17 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.3.0'
 
-  s.add_runtime_dependency 'gamefic', '~> 2.0', '>= 2.0.2'
+  s.add_runtime_dependency 'gamefic', '~> 2.0', '>= 2.1.1'
   s.add_runtime_dependency 'gamefic-standard', '~> 2.0'
-  s.add_runtime_dependency 'gamefic-tty', '~> 2.0', '>= 2.0.1'
+  s.add_runtime_dependency 'gamefic-tty', '~> 2.0', '>= 2.0.2'
   s.add_runtime_dependency 'listen', '~> 3.0'
-  s.add_runtime_dependency 'opal', '~> 1.0'
+  s.add_runtime_dependency 'opal', '~> 1.1'
   s.add_runtime_dependency 'sinatra', '~> 2'
   s.add_runtime_dependency 'thor', '~> 1.0'
 
   s.add_development_dependency 'bundler', '~> 2.0'
   s.add_development_dependency 'capybara', '~> 3.3'
-  s.add_development_dependency 'puma', '~> 3'
+  s.add_development_dependency 'puma', '~> 4'
   s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'selenium-webdriver', '~> 3.13'

data/lib/gamefic-sdk/scaffold.rb

@@ -47,7 +47,7 @@ module Gamefic
           end
         end
         map.each_pair { |src, dst| custom_copy src, dst, data }
-        system "bundle install --gemfile=#{Shellwords.escape(File.join(destination, 'Gemfile'))}"
+        system "cd #{Shellwords.escape(destination)} && bundle install"
       end
     end
   end

data/lib/gamefic-sdk/server.rb

@@ -13,12 +13,7 @@ module Gamefic
 
       post '/start' do
         content_type :json
-        reset_features
-        load File.join(settings.source_dir, 'main.rb')
-        @@plot = Gamefic::Plot.new
-        @@character = @@plot.get_player_character
-        @@plot.introduce @@character
-        @@plot.ready
+        start_plot
         @@character.output.to_json
       end
 
@@ -42,6 +37,7 @@ module Gamefic
 
       post '/restore' do
         content_type :json
+        start_plot
         # The snapshot needs to be received as a JSON string because of issues
         # with IndifferentHash malforming arrays.
         snapshot = JSON.parse(params['snapshot'])
@@ -52,6 +48,15 @@ module Gamefic
         @@character.output.to_json
       end
 
+      def start_plot
+        reset_features
+        load File.join(settings.source_dir, 'main.rb')
+        @@plot = Gamefic::Plot.new
+        @@character = @@plot.get_player_character
+        @@plot.introduce @@character
+        @@plot.ready
+      end
+
       def reset_features
         @@old_features ||= $LOADED_FEATURES.clone
         @@old_constants ||= Object.constants(false)

data/lib/gamefic-sdk/version.rb

@@ -1,5 +1,5 @@
 module Gamefic
   module Sdk
-    VERSION = '2.3.0'
+    VERSION = '2.4.0'
   end
 end

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

@@ -0,0 +1,19 @@
+# <%= name %>
+
+An extension library for Gamefic
+
+## Installation
+
+Add this line to your Gamefic project's Gemfile:
+
+```ruby
+gem '<%= name %>'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+TODO: Write usage instructions here

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

@@ -0,0 +1,44 @@
+# <%= name %>
+
+A Gamefic game project
+
+## Installation
+
+    $ bundle install
+
+## Running on the Command Line
+
+    $ rake ruby:run
+
+## Building a CLI Game
+
+    $ rake ruby:build
+
+The script will be saved in the `builds/ruby` directory.
+
+## Web-Based Games
+
+The Gamefic SDK also supports web-based versions of games. The project gets built into a single-page application with the Ruby game code compiled into JavaScript.
+
+First you need to install the web project scaffold:
+
+    $ rake web:generate
+    $ npm install
+
+## Running a Web Game
+
+To run the app in debug mode:
+
+    $ rake web:run
+
+Open http://localhost:4342 in a browser.
+
+## Building a Web Game
+
+    $ rake web:build
+
+The application will be saved in the `builds/web/production` directory.
+
+## More Information
+
+Go to https://gamefic.com for documentation.

data/scaffolds/react/webpack.config.js

@@ -23,27 +23,30 @@ module.exports = (_env, argv) => {
       })
     ],
     module: {
-        rules: [
-            {
-                test: /\.css$/,
-                use: ['style-loader', 'css-loader']
-            },
-            {
-              test: /\.(png|jp(e*)g|svg)$/,  
-              use: [{
-                  loader: 'url-loader',
-                  options: { 
-                      limit: 8000, // Convert images < 8kb to base64 strings
-                      name: 'images/[hash]-[name].[ext]'
-                  } 
-              }]
-            },
-            {
-                test: /\.jsx?/,
-                include: path.resolve(__dirname, 'web'),
-                use: 'babel-loader'
+      rules: [
+        {
+          test: /\.css$/,
+          use: [
+            'style-loader',
+            { loader: 'css-loader', options: { esModule: false } }
+          ]
+        },
+        {
+          test: /\.(png|jp(e*)g|svg)$/,
+          use: [{
+            loader: 'url-loader',
+            options: {
+              limit: 8000, // Convert images < 8kb to base64 strings
+              name: 'images/[hash]-[name].[ext]'
             }
-        ]
+          }]
+        },
+        {
+          test: /\.jsx?/,
+          include: path.resolve(__dirname, 'web'),
+          use: 'babel-loader'
+        }
+      ]
     }
   }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamefic-sdk
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Fred Snyder
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-14 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gamefic
@@ -19,7 +19,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.1.1
 - !ruby/object:Gem::Dependency
   name: gamefic-standard
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -63,7 +63,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
@@ -84,14 +84,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -154,14 +154,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -248,10 +248,12 @@ files:
 - lib/gamefic-sdk/tasks/web.rb
 - lib/gamefic-sdk/version.rb
 - scaffolds/library/Gemfile
+- scaffolds/library/README.md.gf.erb
 - scaffolds/library/__name__.gemspec.gf.erb
 - scaffolds/library/lib/__name__.rb
 - scaffolds/project/.gitignore
 - scaffolds/project/Gemfile
+- scaffolds/project/README.md.gf.erb
 - scaffolds/project/Rakefile
 - scaffolds/project/main.rb.gf.erb
 - scaffolds/react/.babelrc
@@ -272,7 +274,7 @@ homepage: http://gamefic.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -287,8 +289,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Gamefic SDK
 test_files: []