word_search 0.5.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77f4e1d1505ddcae37cdfacdd41906a8315f3da9
-  data.tar.gz: 23b157e475059758bd1ca08eff8faee31ced31b6
+  metadata.gz: 1ab4c207882de6d2a510e22e640abbdf722623d6
+  data.tar.gz: 8ef6b1e8219ee91afd6b5e8539292fceafd5f3db
 SHA512:
-  metadata.gz: 7189d7726bcc25a675e29ceef9b6c9ae9746948d368c7cb6ed3c84d45099e09540b53af967b9fa4ab3b123099a73eb22427130fc5a8f8fa97c2b7776cac1bd6e
-  data.tar.gz: cd104a514e60a429979ad0b5e6a32b0330bab253c664de2cdd14515716c101f3026e0387441e0c3ecf517ef3f54013ef9f5679e4d02481ee922024daeced4dd3
+  metadata.gz: abbf179e39919da87e853702dad9b42c632ed38ed84af4da3247d21d5881f54255a334e08fcb27280b0f227ee28d60a3075f4620a8e62b40015d666bf60489aa
+  data.tar.gz: db8fad799ccb6361baf556f52282e1d777d3ddff12aa356dfb89fc577fac83b4d2c51f5678536b406a5fbc2c1dfdf4bd3279ac6974e61cd19a99acd4848687aa

data/.gitignore

@@ -1,4 +1,4 @@
-/crossword
+/word_search
 /words.csv
 /.bundle/
 /.yardoc
@@ -12,3 +12,4 @@
 /*.gem
 /docs/.sass-cache
 /docs/build
+solution_*

data/.rubocop.yml

@@ -1043,6 +1043,7 @@ Style/SpecialGlobalVars:
 Style/StringLiterals:
   Description: 'Checks if uses of quotes match the configured preference.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-string-literals'
+  EnforcedStyle: double_quotes
   Enabled: true
 
 Style/StringLiteralsInInterpolation:
@@ -1146,21 +1147,23 @@ Style/WhileUntilModifier:
   Enabled: true
 
 Style/MutableConstant:
-  Enabled: false
+  Enabled: true
 
 Style/FrozenStringLiteralComment:
-  Enabled: false
+  Enabled: true
 
 Style/WordArray:
   Description: 'Use %w or %W for arrays of words.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-w'
   Enabled: true
+
+Style/EmptyMethod:
+  Enabled: false
+
 AllCops:
   Exclude:
     - 'vendor/**/*'
-    - 'config/**/*'
     - 'db/**/*'
-    - 'bin/*'
-    - 'Gemfile'
     - 'Gemfile.lock'
     - 'Rakefile'
+  TargetRubyVersion: 2.3

data/.ruby-version

@@ -1 +1 @@
-2.3.0
+2.3.3

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
-  - 2.3.0
+  - 2.3.3
 script:
-  - rake
+  - bin/test
+  - codeclimate-test-reporter

data/Gemfile

@@ -1,3 +1,4 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -7,7 +7,7 @@
 ## Install
 Add WordSearch to your `Gemfile` and `bundle install`:
 
-`gem 'word_search'`
+`gem "word_search"`
 
 Alternatively, you can install the gem from [rubygems.org](https://rubygems.org/):
 
@@ -30,10 +30,10 @@ zqloh
 muudd
 himyj
 
-# To print to a file(without a filename defaults to 'crossword')
+# To print to a file(without a filename defaults to "word_search")
 ❯ plane.print(file_name)
 
-# When printing a 3D crossword there are two spaces between z slices. The top slice is z = 0.
+# When printing a 3D word search there are two spaces between z slices. The top slice is z = 0.
 ❯ plane = WordSearch::Plane.new(3, 3, 2)
 ❯ plane.add_letters
 ❯ plane.pto_s
@@ -48,7 +48,7 @@ utg
 
 To create plane filled with words supplied by a word bank:
 ```ruby
-❯ generator = WordSearch::Generator.new('words.csv', 5, 5) # or add a z param to get a 3D word search
+❯ generator = WordSearch::Generator.new("words.csv", 5, 5) # or add a z param to get a 3D word search
 ❯ generator.perform
 ❯ generator.word_bank
 => ["word", "hello", "bye"]
@@ -59,3 +59,25 @@ ylcon
 blarz
 yoydt
 ```
+
+To solve or benchmark your solution script:
+```ruby
+❯ solver = WordSearch::Solver.new(
+❯   "path/to/script", "path/to/word/bank", "path/to/word/search"
+❯ )
+❯ solver.perform
+=> #<Benchmark::Tms:0x007fd722cc6b58 @cstime=0.07, @cutime=0.44, @label="", @real=0.5259899999946356, @stime=0.0, @total=0.51, @utime=0.0>
+```
+_NOTE_: Your script should be an executable ruby script that writes the location
+of each letter to a file in the following format and returns the file path:
+```
+h [4, 9]
+e [5, 9]
+l [6, 9]
+l [7, 9]
+o [8, 9]
+---
+b [6, 8]
+y [7, 7]
+e [8, 6]
+```

data/Rakefile

@@ -1,14 +1,28 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-
-task :console do
-  require 'pry'
-  require 'word_searcher'
-  ARGV.clear
-  Pry.start
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-RuboCop::RakeTask.new
-RSpec::Core::RakeTask.new(:spec)
-task default: [:spec, :rubocop]
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Chat"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/bin/console

@@ -1,8 +1,9 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'bundler/setup'
-require 'word_search'
-require 'pry'
-require 'benchmark'
+require "bundler/setup"
+require "word_search"
+require "pry"
+require "benchmark"
 
 Pry.start

data/bin/test

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+require "pathname"
+require "fileutils"
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path("../../", __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  system! "rspec"
+
+  puts "\nChecking rubocop\n"
+  system! "bundle exec rubocop"
+end

data/docs/Gemfile

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
 # If you do not have OpenSSL installed, change
 # the following line to use 'http://'
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # For faster file watcher updates on Windows:
-gem 'wdm', '~> 0.1.0', platforms: [:mswin, :mingw]
+gem "wdm", "~> 0.1.0", platforms: [:mswin, :mingw]
 
 # Windows does not come with time zone data
-gem 'tzinfo-data', platforms: [:mswin, :mingw, :jruby]
+gem "tzinfo-data", platforms: [:mswin, :mingw, :jruby]
 
 # Middleman Gems
-gem 'middleman', '>= 4.0.0'
-gem 'middleman-livereload'
-gem 'middleman-gh-pages'
+gem "middleman", ">= 4.0.0"
+gem "middleman-gh-pages"
+gem "middleman-livereload"
 
-gem 'haml'
+gem "haml"

data/docs/Gemfile.lock

@@ -1,31 +1,31 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.7.1)
+    activesupport (5.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    addressable (2.4.0)
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
     backports (3.6.8)
     coffee-script (2.4.1)
       coffee-script-source
       execjs
-    coffee-script-source (1.10.0)
+    coffee-script-source (1.12.2)
     compass-import-once (1.0.5)
       sass (>= 3.2, < 3.5)
-    concurrent-ruby (1.0.2)
+    concurrent-ruby (1.0.4)
     contracts (0.13.0)
     dotenv (2.1.1)
     em-websocket (0.5.1)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0.6.0)
     erubis (2.7.0)
-    eventmachine (1.2.0.1)
+    eventmachine (1.2.1)
     execjs (2.7.0)
     fast_blank (1.0.0)
-    fastimage (2.0.0)
+    fastimage (2.0.1)
       addressable (~> 2)
     ffi (1.9.14)
     haml (4.0.7)
@@ -35,24 +35,23 @@ GEM
     hashie (3.4.6)
     http_parser.rb (0.6.0)
     i18n (0.7.0)
-    json (1.8.3)
-    kramdown (1.12.0)
+    kramdown (1.13.2)
     listen (3.0.8)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
     memoist (0.15.0)
-    middleman (4.1.10)
+    middleman (4.2.0)
       coffee-script (~> 2.2)
       compass-import-once (= 1.0.5)
       haml (>= 4.0.5)
       kramdown (~> 1.2)
-      middleman-cli (= 4.1.10)
-      middleman-core (= 4.1.10)
+      middleman-cli (= 4.2.0)
+      middleman-core (= 4.2.0)
       sass (>= 3.4.0, < 4.0)
-    middleman-cli (4.1.10)
+    middleman-cli (4.2.0)
       thor (>= 0.17.0, < 2.0)
-    middleman-core (4.1.10)
-      activesupport (~> 4.2)
+    middleman-core (4.2.0)
+      activesupport (>= 4.2, < 5.1)
       addressable (~> 2.3)
       backports (~> 3.6)
       bundler (~> 1.1)
@@ -69,10 +68,10 @@ GEM
       memoist (~> 0.14)
       padrino-helpers (~> 0.13.0)
       parallel
-      rack (>= 1.4.5, < 2.0)
+      rack (>= 1.4.5, < 3)
       sass (>= 3.4)
       servolux
-      tilt (~> 1.4.1)
+      tilt (~> 2.0)
       uglifier (~> 3.0)
     middleman-gh-pages (0.3.1)
       rake (> 0.9.3)
@@ -80,29 +79,30 @@ GEM
       em-websocket (~> 0.5.1)
       middleman-core (>= 3.3)
       rack-livereload (~> 0.3.15)
-    minitest (5.9.1)
-    padrino-helpers (0.13.3.2)
+    minitest (5.10.1)
+    padrino-helpers (0.13.3.3)
       i18n (~> 0.6, >= 0.6.7)
-      padrino-support (= 0.13.3.2)
+      padrino-support (= 0.13.3.3)
       tilt (>= 1.4.1, < 3)
-    padrino-support (0.13.3.2)
+    padrino-support (0.13.3.3)
       activesupport (>= 3.1)
-    parallel (1.9.0)
-    rack (1.6.4)
+    parallel (1.10.0)
+    public_suffix (2.0.5)
+    rack (2.0.1)
     rack-livereload (0.3.16)
       rack
-    rake (11.3.0)
-    rb-fsevent (0.9.7)
+    rake (12.0.0)
+    rb-fsevent (0.9.8)
     rb-inotify (0.9.7)
       ffi (>= 0.5.0)
-    sass (3.4.22)
+    sass (3.4.23)
     servolux (0.12.0)
-    thor (0.19.1)
+    thor (0.19.4)
     thread_safe (0.3.5)
-    tilt (1.4.1)
+    tilt (2.0.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    uglifier (3.0.2)
+    uglifier (3.0.4)
       execjs (>= 0.3.0, < 3)
 
 PLATFORMS
@@ -117,4 +117,4 @@ DEPENDENCIES
   wdm (~> 0.1.0)
 
 BUNDLED WITH
-   1.12.5
+   1.13.7

data/docs/Rakefile

@@ -1 +1,2 @@
-require 'middleman-gh-pages'
+# frozen_string_literal: true
+require "middleman-gh-pages"

data/docs/config.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 ###
 # Page options, layouts, aliases and proxies
 ###
@@ -5,9 +6,9 @@
 # Per-page layout changes:
 #
 # With no layout
-page '/*.xml', layout: false
-page '/*.json', layout: false
-page '/*.txt', layout: false
+page "/*.xml", layout: false
+page "/*.json", layout: false
+page "/*.txt", layout: false
 
 # With alternative layout
 # page "/path/to/file.html", layout: :otherlayout

data/docs/source/index.html.haml

@@ -5,7 +5,7 @@ title: Word Search Gem
 .fork
   .block
     = link_to "https://github.com/npezza93/word_search" do
-      .github-icon
+      %i.fa.fa-github
       Fork on GitHub
 
 .container
@@ -22,9 +22,9 @@ title: Word Search Gem
     Add word_search to your Gemfile and bundle install:
     %pre
       %code
-        gem 'word_search'
-
-    Alternatively, you can install the gem from rubygems.org and require it in your script:
+        gem "word_search"
+    %p
+      Alternatively, you can install the gem from rubygems.org and require it in your script:
     %pre
       %code
         gem install word_search
@@ -39,10 +39,10 @@ title: Word Search Gem
     %pre
       %code
         :preserve
-          require 'word_search'
+          require "word_search"
 
           # You can also add another param, z, to get a 3D word search
-          generator = WordSearch::Generator.new('words.csv', 5, 5)
+          generator = WordSearch::Generator.new("words.csv", 5, 5)
           # Calling #perform will place the words and fill the empty spots
           # with random letters
           generator.perform
@@ -60,7 +60,7 @@ title: Word Search Gem
   %pre
     %code
       :preserve
-        require 'word_search'
+        require "word_search"
 
         plane = WordSearch::Plane.make_from_file("word_search")
         # To find the max of x or y
@@ -84,3 +84,45 @@ title: Word Search Gem
         zqloh
         muudd
         himyj
+
+  %br
+  %br
+
+  %h3
+    Solver
+  %p
+    You can benchmark and check if your solution works by using the Solver class.
+    Your script should be an executable ruby script that writes the location
+    of each letter to a file in the following format and returns the file path.
+    %pre
+      :preserve
+        h [4, 9]
+        e [5, 9]
+        l [6, 9]
+        l [7, 9]
+        o [8, 9]
+        ---
+        b [6, 8]
+        y [7, 7]
+        e [8, 6]
+  %pre
+    %code
+      :preserve
+        require "word_search"
+
+        plane = WordSearch::Solver.new(
+          "path/to/script", "path/to/word/bank", "path/to/word/search"
+        )
+        solver.perform
+        => Benchmark::Tms:0x007fd722cc6b58 @cstime=0.07,
+            @cutime=0.44, @label="", @real=0.5259899999946356,
+            @stime=0.0, @total=0.51, @utime=0.0
+        # If your script fails or is incorrect a message will appear instead
+        # of the benchmark.
+
+#np_logo_container
+  = link_to "https://github.com/npezza93", class: "social-container" do
+    %i.fa.fa-github
+  = image_tag "logo.png", id: "np_logo"
+  = link_to "https://www.linkedin.com/in/nick-pezza-02166668", class: "social-container" do
+    %i.fa.fa-linkedin