gamefic-sdk 2.0.4 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33f493dc96f3c27065f78900fcddbf966da5772770c9ed40f7e8bc665e93851f
-  data.tar.gz: 6a9cde8c298e3640852d34bfa50ecd77df2d0998cec43cf13c3c67855b0c53b2
+  metadata.gz: a5ee344b4b5abb09130b616bb599493ad3fbcc17038aa0f306497dfe9311feab
+  data.tar.gz: f84186419a9963616f6e0b5447cd83609659fb80383315a384ec433623db4740
 SHA512:
-  metadata.gz: 8d7508ff80cb9457cad967c340ad023616df7c25b746d2906a036a737b3da2eae2f04ab94c1cbba85465ac8241c56c3129614a049b0e6ec949b3009e6def7aa0
-  data.tar.gz: 39e7fce05531a992ce3e1de4b01a9869a68103957a999f259559e651fb31fefa69e098956da1d6574778c3c1789c4c2164533b91fcd11775733359014f60dfe1
+  metadata.gz: 9f88ab68b9ef0fb62b06ee12ed91e073fc8a971ec31c7b74ebd9b53671dc62f686b8b66dc1925ccc7ab27f4df4874a01b4992d995b7501a5255fca5db06a950e
+  data.tar.gz: 03f287863bda66c3b6c8553c323553f8daad83e83555bddfdf49e75c6a8e5b7b8890671b8a0b615d677c334c7461cdcf57a6987e2c193d57768ec8bde4d4f242

data/.gitignore

@@ -6,7 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
-/guides/
 
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 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
+
 ## 2.0.4 - April 25, 2020
 - Server does not symbolize snapshot keys
 - Update dependencies

data/gamefic-sdk.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   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/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.0.4'
+    VERSION = '2.3.2'
   end
 end

data/scaffolds/library/README.md.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.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.2.2"
+    "react-gamefic": "^0.5.0"
   }
 }

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

@@ -1,13 +1,24 @@
 import React from 'react';
 import { render } from 'react-dom';
 import { Console, Terminal } from 'react-gamefic';
+
 import { driver } from 'driver';
+
+import { Activity, Pause, MultipleChoice, Conclusion } from './scenes';
 import 'react-gamefic/styles/ebook';
 import './style.css';
 
+const sceneComponents = {
+	Activity: Activity,
+	Pause: Pause,
+	MultipleChoice: MultipleChoice,
+	YesOrNo: MultipleChoice,
+	Conclusion: Conclusion
+}
+
 render(
 	<Console driver={driver}>
-		<Terminal />
+		<Terminal sceneComponents={sceneComponents} autoScroll={true} />
 	</Console>,
 	document.getElementById('root')
 );

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

@@ -0,0 +1,11 @@
+import { Activity } from './Activity.jsx';
+import { Pause } from './Pause.jsx';
+import { MultipleChoice } from './MultipleChoice.jsx';
+import { Conclusion } from './Conclusion.jsx';
+
+export {
+    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.0.4
+  version: 2.3.2
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-25 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gamefic
@@ -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.erb
 - scaffolds/library/__name__.gemspec.gf.erb
 - scaffolds/library/lib/__name__.rb
 - scaffolds/project/.gitignore
 - scaffolds/project/Gemfile
+- scaffolds/project/README.md.erb
 - scaffolds/project/Rakefile
 - scaffolds/project/main.rb.gf.erb
 - scaffolds/react/.babelrc
@@ -261,6 +263,11 @@ 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/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
 homepage: http://gamefic.com
@@ -282,7 +289,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Gamefic SDK