playgroundbook 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cb1f23c12d4c4d5da05b5bd17d0c9309a7d9b68
-  data.tar.gz: 06141cc3c18eb69eb0885438b2e60ab71cc75f67
+  metadata.gz: 74ed5b6506eab19b59be7917fe5314620e1dc893
+  data.tar.gz: 71c9d12ab78353b3b877e6a6379b14eeb8119c92
 SHA512:
-  metadata.gz: db1e4fe2b6a940c9bce9b1ebe085fb347bb2fd43efb8e422ed14a2c8e185da3e527d60e2d5ec8859e769f2cc7ba3b421d2f7520b45501e6eedee71e24f983922
-  data.tar.gz: f0852a23faa7728b67a1cd4cca7eda21e7174ba487cfb8b4f3dbaf889213e6405b1229ec27e7ea5523af3074fb0e8a9ab7c3174b07fc81856f12b814ed014135
+  metadata.gz: 344b95c2eaeda147d21643d537d0c1e5d4e1bee09a277f6f493dac399e8e85fd94d082ee904c7d0420f9c8648378553068b2c9ca1a443eb2aa31bc55b9788eb4
+  data.tar.gz: 1d40b036c24852da1bcbbc992d0ad35e4240d07eec6d394f4e5961973d880d26d039edcde4617c5e170609239888939ecdf0589f3a05f0b4040006405029d6e0

data/.rubocop.yml

@@ -1,2 +1,112 @@
 Metrics/LineLength:
   Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true
+
+# kind_of? is a good way to check a type
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+# It's better to be more explicit about the type
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+# specs sometimes have useless assignments, which is fine
+Lint/UselessAssignment:
+  Exclude:
+    - '**/spec/**/*'
+
+# We could potentially enable the 2 below:
+Style/IndentHash:
+  Enabled: false
+
+Style/AlignHash:
+  Enabled: false
+
+# HoundCI doesn't like this rule
+Style/DotPosition:
+  Enabled: false
+
+# We allow !! as it's an easy way to convert ot boolean
+Style/DoubleNegation:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# We want to allow class Fastlane::Class
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 60
+
+# The %w might be confusing for new users
+Style/WordArray:
+  MinSize: 19
+
+# raise and fail are both okay
+Style/SignalException:
+  Enabled: false
+
+# Better too much 'return' than one missing
+Style/RedundantReturn:
+  Enabled: false
+
+# Having if in the same line might not always be good
+Style/IfUnlessModifier:
+  Enabled: false
+
+# and and or is okay
+Style/AndOr:
+  Enabled: false
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 320
+
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 370
+
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 18
+
+# Sometimes it's easier to read without guards
+Style/GuardClause:
+  Enabled: false
+
+# something = if something_else
+# that's confusing
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Better to have too much self than missing a self
+Style/RedundantSelf:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 60
+
+# We're not there yet
+Style/Documentation:
+  Enabled: false
+
+# Adds complexity
+Style/IfInsideElse:
+  Enabled: false
+
+# danger specific
+
+Style/BlockComments:
+  Enabled: false

data/Changelog.md

@@ -2,6 +2,10 @@
 
 - Nothing yet.
 
+# 0.4.0
+
+- Support converting a random Markdown file into a playground. See [#29](https://github.com/ashfurrow/playgroundbook/pull/29).
+
 # 0.3.0
 
 - Glossary support. See [#18](https://github.com/ashfurrow/playgroundbook/issues/18).

data/Gemfile

@@ -1,12 +1,13 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'guard-rspec'
-gem 'mocha'
-gem 'bacon'
-gem 'mocha-on-bacon'
-gem 'prettybacon'
-gem 'fakefs'
-gem 'rubocop', '~> 0.41.2', require: false
+gem "rake"
+gem "guard-rspec"
+gem "mocha"
+gem "bacon"
+gem "mocha-on-bacon"
+gem "prettybacon"
+gem "fakefs"
+gem "rubocop", "~> 0.41.2", require: false
 
-require 'pp' # https://github.com/defunkt/fakefs/issues/99
+require "pp" # https://github.com/defunkt/fakefs/issues/99
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    playgroundbook (0.2.1)
+    playgroundbook (0.3.0)
       colored (~> 1.2)
       cork (~> 0.1)
       plist (~> 3.2)
@@ -13,7 +13,7 @@ GEM
     bacon (1.2.0)
     coderay (1.1.1)
     colored (1.2)
-    cork (0.1.0)
+    cork (0.2.0)
       colored (~> 1.2)
     diff-lcs (1.2.5)
     fakefs (0.9.0)
@@ -58,6 +58,7 @@ GEM
       method_source (~> 0.8.1)
       slop (~> 3.4)
     rainbow (2.1.0)
+    rake (11.2.2)
     rb-fsevent (0.9.7)
     rb-inotify (0.9.7)
       ffi (>= 0.5.0)
@@ -97,6 +98,7 @@ DEPENDENCIES
   mocha-on-bacon
   playgroundbook!
   prettybacon
+  rake
   rubocop (~> 0.41.2)
 
 BUNDLED WITH

data/Guardfile

@@ -1,5 +1,5 @@
-guard :rspec, cmd: 'bundle exec rspec' do
-  require 'guard/rspec/dsl'
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
   dsl = Guard::RSpec::Dsl.new(self)
 
   # RSpec files

data/Rakefile

@@ -1,6 +1,6 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new

data/bin/playgroundbook

@@ -1,22 +1,24 @@
 #!/usr/bin/env ruby
 
 unless ARGV.length >= 2
-  puts 'You must specify either lint or render. Example usage:'
-  puts '  playgroundbook [lint|render] file_name'
+  puts "You must specify either lint or render. Example usage:"
+  puts "  playgroundbook [lint|render] file_name"
   exit 1
 end
 
 command = ARGV[0]
 file_name = ARGV[1]
 
-require 'playgroundbook'
+require "playgroundbook"
 
-if command == 'lint'
+if command == "lint"
   Playgroundbook::Linter.new(file_name).lint
-elsif command == 'render'
-  Playgroundbook::Renderer.new(file_name).render!
+elsif command == "render"
+  Playgroundbook::Renderer.new(file_name).render
+elsif command == "wrapper"
+  playground_name = ARGV[2]
+  Playgroundbook::MarkdownWrapper.new(file_name, playground_name).generate
 else
   puts "Unknown command: #{command}"
   exit 1
 end
-

data/lib/{playgroundbook_lint → linter}/abstract_linter.rb

@@ -1,5 +1,5 @@
-require 'colored'
-require 'cork'
+require "colored"
+require "cork"
 
 module Playgroundbook
   # AbstractLinter provides a base implementation of a linter which a concrete

data/lib/{playgroundbook_lint → linter}/chapter_linter.rb

@@ -1,9 +1,9 @@
-require 'plist'
-require 'playgroundbook_lint/abstract_linter'
-require 'playgroundbook_lint/chapter_manifest_linter'
+require "plist"
+require "linter/abstract_linter"
+require "linter/chapter_manifest_linter"
 
 module Playgroundbook
-  PAGES_DIRECTORY_NAME = 'Pages'.freeze
+  PAGES_DIRECTORY_NAME = "Pages".freeze
 
   # A linter for verifying a chapter directory
   class ChapterLinter < AbstractLinter

data/lib/{playgroundbook_lint → linter}/chapter_manifest_linter.rb

@@ -1,6 +1,6 @@
-require 'playgroundbook_lint/manifest_linter'
-require 'playgroundbook_lint/page_linter'
-require 'playgroundbook_lint/cutscene_page_linter'
+require "linter/manifest_linter"
+require "linter/page_linter"
+require "linter/cutscene_page_linter"
 
 module Playgroundbook
   # A linter for verifying the contents of a chapter's Manifest.plist
@@ -17,7 +17,7 @@ module Playgroundbook
 
       fail_lint "Chapter has no pages in #{Dir.pwd}" unless chapter_has_manifest_pages?
 
-      manifest_plist_contents['Pages'].each do |page_directory_name|
+      manifest_plist_contents["Pages"].each do |page_directory_name|
         # All pages exist inside the /Pages subdirectory, we need to chdir to there first.
         Dir.chdir PAGES_DIRECTORY_NAME do
           fail_lint "Chapter page directory #{page_directory_name} missing in #{Dir.pwd}" unless Dir.exist?(page_directory_name)
@@ -37,7 +37,7 @@ module Playgroundbook
     end
 
     def chapter_has_manifest_pages?
-      value_defined_in_manifest?('Pages')
+      value_defined_in_manifest?("Pages")
     end
   end
 end

data/lib/{playgroundbook_lint → linter}/contents_linter.rb

@@ -1,5 +1,5 @@
-require 'playgroundbook_lint/abstract_linter'
-require 'playgroundbook_lint/root_manifest_linter'
+require "linter/abstract_linter"
+require "linter/root_manifest_linter"
 
 module Playgroundbook
   # A linter for verifying the contents directory of a playground book
@@ -11,7 +11,7 @@ module Playgroundbook
     end
 
     def lint
-      Dir.chdir 'Contents' do
+      Dir.chdir "Contents" do
         root_manfiest_linter.lint
         # TODO: Other linting?
       end

data/lib/{playgroundbook_lint → linter}/cutscene_page_linter.rb

@@ -1,5 +1,5 @@
-require 'playgroundbook_lint/abstract_linter'
-require 'playgroundbook_lint/cutscene_page_manifest_linter'
+require "linter/abstract_linter"
+require "linter/cutscene_page_manifest_linter"
 
 module Playgroundbook
   # A linter for verifying cutscene pages

data/lib/{playgroundbook_lint → linter}/cutscene_page_manifest_linter.rb

@@ -1,4 +1,4 @@
-require 'playgroundbook_lint/manifest_linter'
+require "linter/manifest_linter"
 
 module Playgroundbook
   # A linter for verifying the contents of a cutscene page's manifest
@@ -9,7 +9,7 @@ module Playgroundbook
       super()
 
       # Cutscene references should point to an existent HTML file
-      cutscene_reference = manifest_plist_contents['CutsceneReference']
+      cutscene_reference = manifest_plist_contents["CutsceneReference"]
       fail_lint "Cutscene manifest doesn't reference a cutscene file" if cutscene_reference.nil?
       fail_lint "Cutscene file at '#{cutscene_reference}' isn't HTML" unless cutscene_reference =~ /^.+\.html$/i
       fail_lint "Cutscene file at '#{cutscene_reference}' doesn't exist" unless File.exist? cutscene_reference

data/lib/{playgroundbook_lint → linter}/manifest_linter.rb

@@ -1,8 +1,8 @@
-require 'plist'
-require 'playgroundbook_lint/abstract_linter'
+require "plist"
+require "linter/abstract_linter"
 
 module Playgroundbook
-  MANIFEST_FILE_NAME = 'Manifest.plist'.freeze
+  MANIFEST_FILE_NAME = "Manifest.plist".freeze
 
   # A base inplementation of a linter for verifying the contents of manifest
   # files.
@@ -20,13 +20,13 @@ module Playgroundbook
 
     def manifest_plist_contents
       return @manifest_plist_contents unless @manifest_plist_contents.nil?
-      require 'plist'
+      require "plist"
       @manifest_plist_contents = Plist.parse_xml(MANIFEST_FILE_NAME)
       @manifest_plist_contents
     end
 
     def name?
-      value_defined_in_manifest?('Name')
+      value_defined_in_manifest?("Name")
     end
 
     def value_defined_in_manifest?(key)

data/lib/{playgroundbook_lint → linter}/page_linter.rb

@@ -1,5 +1,5 @@
-require 'playgroundbook_lint/abstract_linter'
-require 'playgroundbook_lint/page_manifest_linter'
+require "linter/abstract_linter"
+require "linter/page_manifest_linter"
 
 module Playgroundbook
   # A linter for verifying the contents of a page directory

data/lib/{playgroundbook_lint → linter}/page_manifest_linter.rb

@@ -1,5 +1,5 @@
-require 'plist'
-require 'playgroundbook_lint/manifest_linter'
+require "plist"
+require "linter/manifest_linter"
 
 module Playgroundbook
   # A linter for verifying the contents of a page's Manifest.plist
@@ -9,7 +9,7 @@ module Playgroundbook
     def lint
       super()
 
-      live_view_mode = manifest_plist_contents['LiveViewMode']
+      live_view_mode = manifest_plist_contents["LiveViewMode"]
       unless live_view_mode.nil?
         fail_lint "Unsopported LiveViewMoode '#{live_view_mode}'" unless SUPPORTED_LIVE_VIEW_MODES.include? live_view_mode
       end

data/lib/{playgroundbook_lint → linter}/playgroundbook_lint.rb

@@ -1,7 +1,7 @@
-require 'colored'
-require 'playgroundbook_lint/abstract_linter'
-require 'playgroundbook_lint/contents_linter'
-require 'pathname'
+require "colored"
+require "linter/abstract_linter"
+require "linter/contents_linter"
+require "pathname"
 
 module Playgroundbook
   # A linter for verifying a playground book
@@ -17,7 +17,7 @@ module Playgroundbook
     def lint
       message "Validating #{playground_file_name.yellow}..."
 
-      fail_lint 'No Contents directory' unless contents_dir_exists?
+      fail_lint "No Contents directory" unless contents_dir_exists?
 
       Dir.chdir playground_file_name do
         contents_linter.lint
@@ -25,7 +25,7 @@ module Playgroundbook
     end
 
     def contents_dir_exists?
-      Dir.exist?(playground_file_name + '/Contents')
+      Dir.exist?(playground_file_name + "/Contents")
     end
   end
 end

data/lib/{playgroundbook_lint → linter}/root_manifest_linter.rb

@@ -1,6 +1,6 @@
-require 'plist'
-require 'playgroundbook_lint/manifest_linter'
-require 'playgroundbook_lint/chapter_linter'
+require "plist"
+require "linter/manifest_linter"
+require "linter/chapter_linter"
 
 module Playgroundbook
   # A linter for verifying the contents of a playground book's root manifest
@@ -14,23 +14,23 @@ module Playgroundbook
     def lint
       super()
 
-      fail_lint 'No Chapters directory' unless chapters_directory_exist?
-      fail_lint 'No Chapters specified' unless chapters_exist?
+      fail_lint "No Chapters directory" unless chapters_directory_exist?
+      fail_lint "No Chapters specified" unless chapters_exist?
 
       # Go into Chapters/ and then each chapter directory, then lint it.
-      Dir.chdir 'Chapters' do
-        manifest_plist_contents['Chapters'].each do |chapter_directory_name|
+      Dir.chdir "Chapters" do
+        manifest_plist_contents["Chapters"].each do |chapter_directory_name|
           chapter_linter.lint(chapter_directory_name)
         end
       end
     end
 
     def chapters_directory_exist?
-      Dir.exist? 'Chapters'
+      Dir.exist? "Chapters"
     end
 
     def chapters_exist?
-      value_defined_in_manifest?('Chapters')
+      value_defined_in_manifest?("Chapters")
     end
   end
 end