word_search 0.5.1 → 1.0.0

data/docs/source/layouts/layout.html.haml

@@ -3,18 +3,16 @@
   %head
     %meta{content: "text/html; charset=UTF-8", "http-equiv" => "Content-Type"}/
     %meta{content: "IE=edge", "http-equiv" => "X-UA-Compatible"}/
-    %meta{:charset => "utf-8"}/
-    %meta{content: "width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no", :name => "viewport"}/
+    %meta{charset: "utf-8"}/
+    %meta{content: "width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no", name: "viewport"}/
 
-    %script{:src => "//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/highlight.min.js"}
-    %link{:href => "//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/styles/atom-one-dark.min.css", :rel => "stylesheet"}/
+    %script{src: "//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/highlight.min.js"}
+    %link{href: "//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/styles/atom-one-dark.min.css", rel: "stylesheet"}/
 
     %title= current_page.data.title || "Middleman"
-    %link{:href => "//fonts.googleapis.com/css?family=Lato:300,400", :rel => "stylesheet", :type => "text/css"}/
-    %link{:href => "//fonts.googleapis.com/css?family=Droid+Sans+Mono", :rel => "stylesheet", :type => "text/css"}/
-
-    = stylesheet_link_tag :site
-    = javascript_include_tag :all
+    = favicon_tag 'images/search.png'
+    = stylesheet_link_tag "//fonts.googleapis.com/css?family=Lato:300,400", "//fonts.googleapis.com/css?family=Droid+Sans+Mono", :site
+    = javascript_include_tag "//use.fontawesome.com/1118bc452f.js", :all
 
   %body{:class => page_classes}
     = yield

data/docs/source/stylesheets/site.css.sass

@@ -0,0 +1,83 @@
+@charset "utf-8"
+@import normalize
+
+body
+  background: #F9F7E9
+  font-family: "Lato", "Helvetica Neue", Helvetica, Arial, sans-serif
+
+h1
+  color: #66BEAD
+  font-family: "Lato", "Helvetica Neue", Helvetica, Arial, sans-serif
+  font-size: 3.5em
+  font-weight: 400
+  margin: 0
+  padding: 20px
+
+.container
+  width: 700px
+  max-width: 90%
+  margin: auto
+
+.hljs
+  padding: 20px
+  font-family: 'Droid Sans Mono', monospace
+  background: rgba(40, 44, 52, 0.8)
+
+.center
+  text-align: center
+
+h4, p, h3
+  color: #66BEAD
+
+.fork .block
+  justify-content: flex-end
+  display: flex
+  flex-direction: row
+
+  a
+    display: flex
+    flex-direction: row
+    align-items: center
+    cursor: pointer
+    margin: 7px
+    margin-right: 13px
+    padding: 10px
+    color: #66BEAD
+    background: transparent
+    transition: all 0.5s ease
+    text-decoration: none
+
+    i
+      font-size: 27px
+      margin-right: 10px
+
+    &:hover
+      color: #167C80
+
+#np_logo_container
+  margin-top: 150px
+  margin-bottom: 25px
+  width: 100%
+  height: 75px
+  display: flex
+  align-items: center
+  justify-content: center
+  img
+    height: 100%
+    margin: 0 20px
+  a
+    width: 45px
+    height: 45px
+    background: #66BEAD
+    border-radius: 50%
+    display: flex
+    align-items: center
+    justify-content: center
+    text-decoration: none
+    color: #F9F7E9
+    cursor: pointer
+    i
+      font-size: 30px
+
+.hljs-comment, .hljs-quote
+  color: #79808f !important

data/lib/word_search.rb

@@ -1,31 +1,32 @@
-require 'active_model'
-require 'active_support'
-require 'active_support/all'
-require 'csv'
-require 'ruby-enum'
+# frozen_string_literal: true
+require "active_model"
+require "active_support"
+require "active_support/all"
+require "csv"
+require "ruby-enum"
 
-require 'word_search/version'
-require 'word_search/plane'
-require 'word_search/word_bank'
-require 'word_search/generator'
-require 'word_search/catalog'
-require 'word_search/solver'
+require "word_search/version"
+require "word_search/plane"
+require "word_search/word_bank"
+require "word_search/generator"
+require "word_search/catalog"
+require "word_search/solver"
 
-require 'word_search/plane/base'
-require 'word_search/generator/base'
-require 'word_search/position_word/base'
+require "word_search/plane/base"
+require "word_search/generator/base"
+require "word_search/position_word/base"
 
-require 'word_search/three_dimensional/plane'
-require 'word_search/three_dimensional/point'
-require 'word_search/three_dimensional/direction'
-require 'word_search/three_dimensional/generator'
-require 'word_search/three_dimensional/position_word'
+require "word_search/three_dimensional/plane"
+require "word_search/three_dimensional/point"
+require "word_search/three_dimensional/direction"
+require "word_search/three_dimensional/generator"
+require "word_search/three_dimensional/position_word"
 
-require 'word_search/two_dimensional/plane'
-require 'word_search/two_dimensional/point'
-require 'word_search/two_dimensional/direction'
-require 'word_search/two_dimensional/generator'
-require 'word_search/two_dimensional/position_word'
+require "word_search/two_dimensional/plane"
+require "word_search/two_dimensional/point"
+require "word_search/two_dimensional/direction"
+require "word_search/two_dimensional/generator"
+require "word_search/two_dimensional/position_word"
 
 module WordSearch
 end

data/lib/word_search/catalog.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module WordSearch
   class Catalog < Hash
   end

data/lib/word_search/generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module WordSearch
   class Generator < SimpleDelegator
     include ActiveModel::Validations
@@ -23,6 +24,7 @@ module WordSearch
 
       if valid?
         plane.add_letters
+        write_solution
         plane
       else
         false
@@ -42,19 +44,23 @@ module WordSearch
     def words_too_long
       "#{word_bank.longest_words.join(' and ')} "\
       "#{'is'.pluralize(word_bank.longest_words.count)} "\
-      'too long for the word search'
+      "too long for the word search"
     end
 
     def valid_plane?
+      return if plane.valid?
+
       plane.errors.full_messages.each do |msg|
         errors.add(:base, msg)
-      end unless plane.valid?
+      end
     end
 
     def valid_word_bank?
+      return if word_bank.valid?
+
       word_bank.errors.full_messages.each do |msg|
         errors.add(:base, msg)
-      end unless word_bank.valid?
+      end
     end
   end
 end

data/lib/word_search/generator/base.rb

@@ -1,28 +1,76 @@
+# frozen_string_literal: true
 module WordSearch
   class Generator
     class Base
       include ActiveModel::Validations
 
-      attr_accessor :plane, :word_bank, :used_coordinates
+      attr_accessor :plane, :word_bank, :used_coordinates, :positions
       delegate :to_s, :pto_s, :print, :catalog, to: :plane
 
+      def directions
+        raise NotImplementedError
+      end
+
       def initialize(plane, word_bank)
         @plane = plane
         @word_bank = word_bank
         @used_coordinates = []
+        @positions = {}
       end
 
       def perform
         word_bank.each do |word|
-          place_word(word)
+          @positions[word] = place_word(word)
+        end
+      end
+
+      def write_solution
+        file_name = "solution_#{plane.digest}"
+        File.open(file_name, "w") do |f|
+          solution = positions.map do |_word, letter_positions|
+            letter_positions.map do |letter, position|
+              "#{letter.split('-')[0]} #{position.values}"
+            end.join("\n")
+          end.join("\n---\n")
+
+          f.write solution
         end
       end
 
       private
 
+      def place_word(word)
+        placed = false
+        until placed || used_coordinates.uniq.count == plane.total_points
+          placed = position_word(word)
+        end
+
+        word_bank.errors.add(word, "cannot be placed") if placed.blank?
+        placed
+      end
+
+      def position_word(word)
+        used_coordinates << (coordinate = random_point)
+        position = false
+
+        directions.find do |direction|
+          dimension = plane.two_dimensional? ? TwoDimensional : ThreeDimensional
+          position =
+            dimension::PositionWord.new(
+              plane, word, direction, coordinate
+            ).perform
+        end
+
+        position
+      end
+
       def random(number)
         SecureRandom.random_number number
       end
+
+      def random_point
+        raise NotImplementedError
+      end
     end
   end
 end

data/lib/word_search/plane.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module WordSearch
   class Plane < SimpleDelegator
     def self.make_from_file(file)

data/lib/word_search/plane/base.rb

@@ -1,18 +1,21 @@
+# frozen_string_literal: true
 module WordSearch
   class Plane
     class Base < Hash
       include ActiveModel::Validations
 
+      LETTERS = ("a".."z").to_a
+
       attr_accessor :x, :y, :catalog
 
       validates :x, :y, numericality: { greater_than_or_equal_to: 2 }
 
       def print(file_name = nil)
-        File.open(file_name || 'word_search', 'w') { |f| f.write to_s }
+        File.open(file_name || "word_search", "w") { |f| f.write to_s }
       end
 
       def random_letter
-        ('a'..'z').to_a[SecureRandom.random_number(26)]
+        LETTERS.sample
       end
 
       def two_dimensional?
@@ -35,6 +38,26 @@ module WordSearch
         puts to_s
       end
 
+      def digest
+        Digest::MD5.hexdigest(to_s)
+      end
+
+      def to_s
+        raise NotImplementedError
+      end
+
+      def total_points
+        raise NotImplementedError
+      end
+
+      def max
+        raise NotImplementedError
+      end
+
+      def directions
+        raise NotImplementedError
+      end
+
       private
 
       def initialize_plane