combinatorial_puzzle_solver 0.1.4 → 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c97ab26d922c738ae675bbc88cb26d8b8d259d5
+  data.tar.gz: f2cf755474ec48ee6b028795e243619fef637976
+SHA512:
+  metadata.gz: 616483c367ca49dfbbea46f862dcda1bdfae2b5f07eaf3dacab3cacaffa0e87f5dd6054745d2bd6d019999010176335a4c9269660b80718cf385019cfdc8a0bf
+  data.tar.gz: bb60d2804922912522d8622e1feee0124030754c8a68ba0ed4125cd972806f290511d51e3eb6d042efda925e691dce3ca0aa4e9a6650dd72b189b1dd002d300c

data/README.md

@@ -20,15 +20,33 @@ Or install it yourself as:
 
 ## Usage for `solve_sudoku`
 
-The program `solve_sudoku` reads sudoku puzzles from files (or stdin, if no filenames is given) and solves them by constraint resolution. If constraint resolution is not enough to solve the puzzle, it will resort to a trial and error approach. The exit code will indicate if all parsed puzzles was completely solved or not.
-Each resolution step and the current state of the puzzle can be written to stdout for diagnostic purposes. It is also possible to abort after a given number of steps if a complete resolution is not desired, which would be the case if you only want a couple of clues.
-Note that the step output and abort functionality is not available when the puzzle is solved by trial and error.
-The default behavior is resolve all given puzzles (with trial and error, if neccessary) and indicate by exit status whether all puzzles where completely resolved. No output is given unless explicitly asked for.
+The program `solve_sudoku` reads sudoku puzzles from files
+(or stdin, if no filenames is given) and solves them by
+constraint resolution. If constraint resolution is not enough
+to solve the puzzle, it will resort to a trial and error
+approach. The exit code will indicate if all parsed puzzles
+were completely solved or not.
+
+Each resolution step and the current state of the puzzle can
+be written to stdout for diagnostic purposes. It is also
+possible to abort after a given number of steps if a complete
+resolution is not desired, which would be the case if you only
+want a couple of clues.
+
+Note that the step output and abort functionality is not
+available when the puzzle is solved by trial and error.
+
+The default behavior is resolve all given puzzles (with trial
+and error, if neccessary) and indicate by exit status whether
+all puzzles where completely resolved. No output is given
+unless explicitly asked for.
 
 
 ###Printing the parsed puzzles, `-i`.
 
-The parser will interpret digits (0-9) as values in the puzzle and disregard anything else. The option `-i` will output the parsed puzzle before it solves it.
+The parser will interpret digits (0-9) as values in the puzzle
+and disregard anything else. The option `-i` will output the
+parsed puzzle before it solves it.
 
 Given the file `example_puzzles/simple`:
 
@@ -333,7 +351,9 @@ Invoking `solve_sudoku example_puzzles/4x4 --4x4 -p` will return exit code `0` a
 
 ###Use constraint resolution only, `-r`.
 
-You can avoid the trial and error functionality. Note though that this might not lead to a completely solved puzzle, which would imply a failure return code.
+You can avoid the trial and error functionality. Note though that this might not
+lead to a completely solved puzzle, which would imply a failure return code.
+
 The input and incomplete result is demonstrated below.
 
 Given the file `example_puzzles/medium`:
@@ -427,7 +447,9 @@ Invoking `solve_sudoku example_puzzles/hard -i -o -r` will return exit code `256
 
 ###Abort after a given number of steps, `-c NUM`, `--clues NUM`.
 
-If you don't want the entire puzzle solved, but just a couple of clues on how to get forward, you can abort the resolution with `-c`, and print each step with  `-s`.
+If you don't want the entire puzzle solved, but just a couple of clues on
+how to get forward, you can abort the resolution with `-c`, and print each
+step with  `-s`.
 
 Given the file `example_puzzles/simple`:
 
@@ -450,6 +472,7 @@ Invoking `solve_sudoku example_puzzles/simple -s -c 3` will return exit code `0`
 	
 
 
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/Rakefile

@@ -1,40 +1,40 @@
 require "bundler/gem_tasks"
 Bundler.setup
 
-desc "Execute RSpec with default formatter"
+require 'rake/clean'
+require 'yard'
+require 'rspec/illustrate/yard'
 require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = "--format RSpec::Formatters::IllustratedDocumentationFormatter"
-end
 
-desc "Execute RSpec with HTML formatter"
-# RSpec - HTML output
-RSpec::Core::RakeTask.new(:html_spec) do |t|
-  t.rspec_opts = "--format RSpec::Formatters::IllustratedHtmlFormatter --out ./doc/rspec-results.html"
-end
+desc "Execute tests"
+RSpec::Core::RakeTask.new(:test)
 
-desc "Generate API documentation."
-require 'yard'
-YARD::Rake::YardocTask.new(:doc) do |t|
-  t.files   = ['lib/**/*.rb', '-', 'doc/rspec-results.html', 'doc/examples.md' ]
+desc "Execute RSpec and create a test report at ./doc/api.rspec."
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--format RSpec::Formatters::YARD --out ./doc/api.rspec"
 end
-task :doc => [:html_spec, :examples]
 
-desc "List the undocumented code."
-YARD::Rake::YardocTask.new(:list_undoc) do |t|
-  t.stats_options = ['--list-undoc']
+desc "Create documentation."
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files   = ['lib/**/*.rb', 'doc/api.rspec', '-', 'doc/api.rspec', 'doc/examples.md' ]
 end
+task :doc => [:spec, :examples]
+CLEAN.include("doc")
+CLEAN.include(".yardoc")
 
-# Generate examples and documentation
+desc "Create example documentation."
 require_relative 'example_puzzles/compile_examples'
 task :examples => ['doc/examples.md']
 file 'doc/examples.md' => FileList["example_puzzles/*"] do
-  markdown = compile_examples_to_markdown(Dir.glob('example_puzzles/*.yaml'))
+  markdown = compile_examples_to_markdown(Dir.glob('example_puzzles/*.yaml'),2)
   File.write('doc/examples.md', markdown)
   $stderr.puts "examples ok!"
 end
 
+desc "List the undocumented code."
+YARD::Rake::YardocTask.new(:list_undoc) do |t|
+  t.stats_options = ['--list-undoc']
+end
 
-task :test => [:spec, :examples]
 task :default => :doc
 

data/combinatorial_puzzle_solver.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.8"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec-illustrate", "~> 0.1.3"
+  spec.add_development_dependency "rspec-illustrate", "~> 0.2.0"
 
   spec.add_development_dependency "yard", "~>  0.8.7.6"
   spec.add_development_dependency "redcarpet", "~>  3.2.2"

data/example_puzzles/compile_examples.rb

@@ -6,9 +6,10 @@ require 'open3'
 # it into a markdown doucument.
 #
 # @param yaml_files [Array<String>] the yaml files to parse
+# @param level [Fixnum] the initial subsection level
 # @return [String] the compiled markdown document.
-def compile_examples_to_markdown(yaml_files)
-  compile(yaml_files.collect{|yaml_file| YAML.load_file(yaml_file)})
+def compile_examples_to_markdown(yaml_files, level)
+  compile(yaml_files.collect{|yaml_file| YAML.load_file(yaml_file)}, level)
 end
 
 # Compiles a given node of the YAML tree into markdown.

data/example_puzzles/examples.yaml

@@ -1,13 +1,13 @@
 ---
 :section: Sudoku Solver
 :content:
-- :comment: >
+- :comment: |
     The program `solve_sudoku` reads sudoku puzzles from files
     (or stdin, if no filenames is given) and solves them by
     constraint resolution. If constraint resolution is not enough
     to solve the puzzle, it will resort to a trial and error
     approach. The exit code will indicate if all parsed puzzles
-    was completely solved or not.
+    were completely solved or not.
 
     Each resolution step and the current state of the puzzle can
     be written to stdout for diagnostic purposes. It is also
@@ -24,7 +24,7 @@
     unless explicitly asked for.
 
 - :example: Printing the parsed puzzles, `-i`.
-  :comment: >
+  :comment: |
     The parser will interpret digits (0-9) as values in the puzzle
     and disregard anything else. The option `-i` will output the
     parsed puzzle before it solves it.
@@ -186,7 +186,7 @@
               2\n---+---\n4 2|1 3\n3 1|2 4\n\n2 3|4 1\n1 4|3 2\n---+---\n4 2|1 3\n3 1|2 4\n\n"
 
 - :example: Use constraint resolution only, `-r`.
-  :comment: >
+  :comment: |
     You can avoid the trial and error functionality. Note though that this might not
     lead to a completely solved puzzle, which would imply a failure return code.
 
@@ -227,7 +227,7 @@
 
 
 - :example: Abort after a given number of steps, `-c NUM`, `--clues NUM`.
-  :comment: >
+  :comment: |
       If you don't want the entire puzzle solved, but just a couple of clues on
       how to get forward, you can abort the resolution with `-c`, and print each
       step with  `-s`.

data/lib/combinatorial_puzzle_solver/version.rb

@@ -1,4 +1,4 @@
 module CombinatorialPuzzleSolver
   # the current version
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,94 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: combinatorial_puzzle_solver
 version: !ruby/object:Gem::Version
-  version: 0.1.4
-  prerelease: 
+  version: 0.1.5
 platform: ruby
 authors:
 - Erik Schlyter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-22 00:00:00.000000000 Z
+date: 2015-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec-illustrate
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.7.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.7.6
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.2
 description: A resolver of combinatorial number-placement puzzles, like Sudoku.
@@ -99,7 +88,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -125,30 +114,26 @@ files:
 homepage: https://github.com/ErikSchlyter/combinatorial_puzzle_solver
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2443890313582530978
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A resolver of combinatorial number-placement puzzles, like Sudoku.
 test_files: []
 has_rdoc: