gamefic-sdk 2.1.0 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e191127d0c07f062207511ce1abb9b6b8237252a2c211751554673cc43a9572d
-  data.tar.gz: e68a2692143010304e89abe4ccaf5d99f3227a39f89ef10c1cb7d56df6ed0c25
+  metadata.gz: 1eae9343564055a00e7ca5cf1039ab349af0c67dfe75a17edf3d2f09506dbb65
+  data.tar.gz: 4bf5da93fd0d2b5dfd6d4b630c2bbdb0c7ee7e5eab592d62d3c6169d74ed082d
 SHA512:
-  metadata.gz: b871b39cc1371113111d917ec0ff01180483daefefbe9725e95f1d486f9b72d708215b8ca8b483784b908d3682c7430b29ecb6fc13953b626c92b170555a315e
-  data.tar.gz: a3e31833934272af6363b821f76cb8b1af8427b1797ccc0b61dcaff023aa9dc6323b9b4de174387d659a9ee1307020be81ee111560b173dba2b2afb99e6874f9
+  metadata.gz: 46e0e4f96795702bb01071048284827944d23dcb75fb8de9b0aadc06eb48658db5554e27ad809ff925b17fee4b0a878ae7120569e7cd2b7cdd366f3a999c90e1
+  data.tar.gz: b8de100c44bd07dbfbc04423ba97a68ef275820d1d43f912016be4f633effd4fc9e9f29e968f99f714f5015dafd329b7deebf9015a1c5838289df292f1adf768

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 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
+
+## 2.2.0 - August 29, 2020
+- Update to react-gamefic 0.4.0
+
 ## 2.1.0 - August 27, 2020
 - Update web app with customizable scene components
 

data/gamefic-sdk.gemspec

@@ -24,11 +24,11 @@ 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 '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'
 

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/tasks/web.rb

@@ -41,7 +41,6 @@ module Gamefic
         def build
           check_for_web_build
           Dir.chdir absolute_path do
-            # exec 'npm run build'
             pid = Process.spawn 'npm run build'
             Process.wait pid
           end

data/lib/gamefic-sdk/version.rb

@@ -1,5 +1,5 @@
 module Gamefic
   module Sdk
-    VERSION = '2.1.0'
+    VERSION = '2.3.3'
   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,49 @@
+# <%= 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
+```
+
+## 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/.babelrc

@@ -1,3 +1,3 @@
 {
-	"presets" : ["env", "react"]
+	"presets" : ["@babel/preset-env", "@babel/preset-react"]
 }

data/scaffolds/react/package.json.gf.erb

@@ -8,27 +8,27 @@
   "private": true,
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "webpack --env=production -p",
-    "develop": "webpack --env=development -d"
+    "build": "webpack --mode production",
+    "develop": "webpack --mode development"
   },
   "devDependencies": {
-    "babel-core": "^6.26.3",
-    "babel-loader": "^7.1.5",
-    "babel-preset-env": "^1.7.0",
-    "babel-preset-react": "^6.24.1",
-    "copy-webpack-plugin": "^4.5.3",
-    "css-loader": "^1.0.0",
-    "file-loader": "^3.0.1",
+    "@babel/core": "^7.12.0",
+    "babel-loader": "^8.2.2",
+    "@babel/preset-env": "^7.12.10",
+    "@babel/preset-react": "^7.12.10",
+    "copy-webpack-plugin": "^7.0.0",
+    "css-loader": "^5.0.1",
+    "file-loader": "^6.2.0",
     "opal-webpack-bundler": "^0.0.1",
     "style-loader": "^0.23.1",
-    "url-loader": "^1.1.2",
-    "webpack": "^4.20.2",
-    "webpack-cli": "^3.1.2"
+    "url-loader": "^4.1.1",
+    "webpack": "^5.10.1",
+    "webpack-cli": "^4.2.0"
   },
   "dependencies": {
     "gamefic-driver": "^0.2.1",
     "react": "^16.5.2",
     "react-dom": "^16.5.2",
-    "react-gamefic": "^0.3.0"
+    "react-gamefic": "^0.5.0"
   }
 }

data/scaffolds/react/web/src/index.js

@@ -4,16 +4,16 @@ import { Console, Terminal } from 'react-gamefic';
 
 import { driver } from 'driver';
 
-import { ActivityScene, PauseScene, MultipleChoiceScene, ConclusionScene } from './scenes';
+import { Activity, Pause, MultipleChoice, Conclusion } from './scenes';
 import 'react-gamefic/styles/ebook';
 import './style.css';
 
 const sceneComponents = {
-	Activity: ActivityScene,
-	Pause: PauseScene,
-	MultipleChoice: MultipleChoiceScene,
-	YesOrNo: MultipleChoiceScene,
-	Conclusion: ConclusionScene
+	Activity: Activity,
+	Pause: Pause,
+	MultipleChoice: MultipleChoice,
+	YesOrNo: MultipleChoice,
+	Conclusion: Conclusion
 }
 
 render(

data/scaffolds/react/web/src/scenes/Activity.jsx

@@ -0,0 +1,13 @@
+import React from 'react';
+import { ActivityScene, Output, CommandForm } from 'react-gamefic';
+
+export class Activity extends React.Component {
+	render() {
+		return (
+			<ActivityScene>
+				<Output {...this.props} transcribe={true} />
+				<CommandForm prompt={this.props.state.prompt} />
+			</ActivityScene>
+		);
+	}
+}

data/scaffolds/react/web/src/scenes/Conclusion.jsx

@@ -0,0 +1,12 @@
+import React from 'react';
+import { ConclusionScene, Output } from 'react-gamefic';
+
+export class Conclusion extends React.Component {
+	render() {
+		return (
+			<ConclusionScene>
+				<Output {...this.props} transcribe={true} />
+			</ConclusionScene>
+		);
+	}
+}

data/scaffolds/react/web/src/scenes/MultipleChoice.jsx

@@ -0,0 +1,13 @@
+import React from 'react';
+import { MultipleChoiceScene, ChoiceList } from 'react-gamefic';
+
+export class MultipleChoice extends React.Component {
+	render() {
+		return (
+			<MultipleChoiceScene>
+				<Output {...this.props} transcribe={true} />,
+				<ChoiceList options={this.props.state.options} prompt={this.props.state.prompt} />
+			</MultipleChoiceScene>
+		);
+	}
+}

data/scaffolds/react/web/src/scenes/Pause.jsx

@@ -0,0 +1,13 @@
+import React from 'react';
+import { PauseScene, Output, CommandLink } from 'react-gamefic';
+
+export class Pause extends React.Component {
+	render() {
+		return (
+			<PauseScene>
+				<Output {...this.props} transcribe={true} />
+				<CommandLink command="">Continue</CommandLink>
+			</PauseScene>
+		);
+	}
+}

data/scaffolds/react/web/src/scenes/index.js

@@ -1,11 +1,11 @@
-import { ActivityScene } from './ActivityScene.jsx';
-import { PauseScene } from './PauseScene.jsx';
-import { MultipleChoiceScene } from './MultipleChoiceScene.jsx';
-import { ConclusionScene } from './ConclusionScene.jsx';
+import { Activity } from './Activity.jsx';
+import { Pause } from './Pause.jsx';
+import { MultipleChoice } from './MultipleChoice.jsx';
+import { Conclusion } from './Conclusion.jsx';
 
 export {
-    ActivityScene,
-    PauseScene,
-    MultipleChoiceScene,
-    ConclusionScene
+    Activity,
+    Pause,
+    MultipleChoice,
+    Conclusion
 }

data/scaffolds/react/webpack.config.js

@@ -1,51 +1,56 @@
 const path = require('path');
 const CopyWebpackPlugin = require('copy-webpack-plugin');
 
-module.exports = (env) => {
+module.exports = (_env, argv) => {
   var config = {
     entry: path.resolve(__dirname, 'web', 'src', 'index.js'),
     output: {
       filename: 'bundle.js',
-      path: path.resolve(__dirname, "builds", "web", env)
+      path: path.resolve(__dirname, "builds", "web", argv.mode)
     },
     resolve: {
       alias: {
-        driver: path.join(__dirname, 'web', 'src', 'driver', env)
+        driver: path.join(__dirname, 'web', 'src', 'driver', argv.mode)
       }
     },
     plugins: [
-        new CopyWebpackPlugin([
-            {
-                from: path.resolve(__dirname, 'web', 'public')
-            },
-        ])
+      new CopyWebpackPlugin({
+        patterns: [
+          {
+            from: path.resolve(__dirname, 'web', 'public')
+          }
+        ]
+      })
     ],
     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'
+        }
+      ]
     }
   }
 
-  if (env == 'production') {
+  if (argv.mode == 'production') {
     config.module.rules.push(
       {
         // opal-webpack-bundler will compile and include ruby files in the pack

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamefic-sdk
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.3
 platform: ruby
 authors:
 - Fred Snyder
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-27 00:00:00.000000000 Z
+date: 2021-07-03 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
@@ -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
@@ -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
@@ -261,10 +263,10 @@ files:
 - scaffolds/react/web/src/driver/opal.rb
 - scaffolds/react/web/src/driver/production.js
 - scaffolds/react/web/src/index.js
-- scaffolds/react/web/src/scenes/ActivityScene.jsx
-- scaffolds/react/web/src/scenes/ConclusionScene.jsx
-- scaffolds/react/web/src/scenes/MultipleChoiceScene.jsx
-- scaffolds/react/web/src/scenes/PauseScene.jsx
+- scaffolds/react/web/src/scenes/Activity.jsx
+- scaffolds/react/web/src/scenes/Conclusion.jsx
+- scaffolds/react/web/src/scenes/MultipleChoice.jsx
+- scaffolds/react/web/src/scenes/Pause.jsx
 - scaffolds/react/web/src/scenes/index.js
 - scaffolds/react/web/src/style.css
 - scaffolds/react/webpack.config.js
@@ -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: []

data/scaffolds/react/web/src/scenes/ActivityScene.jsx

@@ -1,13 +0,0 @@
-import React from 'react';
-import { Output, CommandForm } from 'react-gamefic';
-
-export class ActivityScene extends React.Component {
-	render() {
-		return (
-			<div className="ActivityScene">
-				<Output {...this.props} />
-				<CommandForm prompt={this.props.state.prompt} />
-			</div>
-		);
-	}
-}

data/scaffolds/react/web/src/scenes/ConclusionScene.jsx

@@ -1,12 +0,0 @@
-import React from 'react';
-import { Output } from 'react-gamefic';
-
-export class ConclusionScene extends React.Component {
-	render() {
-		return (
-			<div className="ConclusionScene">
-				<Output {...this.props} />
-			</div>
-		);
-	}
-}

data/scaffolds/react/web/src/scenes/MultipleChoiceScene.jsx

@@ -1,37 +0,0 @@
-import React from 'react';
-import { Output } from 'react-gamefic';
-import { CommandLink } from 'react-gamefic';
-
-export class MultipleChoiceScene extends React.Component {
-	renderChoices() {
-		if (this.props.state.options) {
-			const listItems = this.props.state.options.map((opt, index) => {
-				return (
-					<li key={index}>
-						<CommandLink command={opt}>{opt}</CommandLink>
-					</li>
-				);
-			});
-			return (
-				<nav>
-					<ol>
-						{listItems}
-					</ol>
-				</nav>
-			);
-		} else {
-			console.warn("Error: Multiple choice scene does not have any options");
-			return '';
-		}
-	}
-
-	render() {
-		return (
-			<div className="MultipleChoiceScene">
-				<Output {...this.props} />
-				<label>{this.props.state.prompt}</label>
-				{this.renderChoices()}
-			</div>
-		);
-	}
-}

data/scaffolds/react/web/src/scenes/PauseScene.jsx

@@ -1,13 +0,0 @@
-import React from 'react';
-import { Output, CommandLink, CommandForm } from 'react-gamefic';
-
-export class PauseScene extends React.Component {
-	render() {
-		return (
-			<div className="PauseScene">
-				<Output {...this.props} />
-				<CommandLink command="">Continue</CommandLink>
-			</div>
-		);
-	}
-}