picky-generators 4.12.1 → 4.12.2

data/lib/picky-generators/generators/all_in_one/sinatra.rb

@@ -18,22 +18,20 @@ module Picky
         #
         #
         def generate
-          exclaim "Setting up Picky Sinatra Client/Server \"#{name}\"."
-          create_target_directory
-          copy_all_files
-          copy_all_files expand_prototype_path('shared/server')
-          copy_all_files expand_prototype_path('shared/both')
-          copy_all_files expand_prototype_path('shared/client')
-          exclaim "\"#{name}\" is a great project name! Have fun :)\n"
-          exclaim ""
-          exclaim "Next steps:"
-          exclaim "1. cd #{name}"
-          exclaim "2. bundle install"
-          exclaim "3. rake index"
-          exclaim "4. unicorn -c unicorn.rb"
-          exclaim "5. open http://localhost:8080/"
-          exclaim "6. rake todo      # (optional) shows you where Picky needs input from you"
-          exclaim "                  #            if you want to define your own search."
+          generate_for "Sinatra Client/Server",
+          [
+            'shared/server',
+            'shared/both',
+            'shared/client'
+          ],
+          [
+            "cd #{name}",
+            "bundle install",
+            "rake index",
+            "unicorn -c unicorn.rb",
+            "open http://localhost:8080/",
+            "rake todo # (optional) Shows you where Picky needs input from you."
+          ]
         end
 
       end

data/lib/picky-generators/generators/base.rb

@@ -117,6 +117,25 @@ module Picky
         puts something
       end
       
+      def generate_for type, prototype_paths, steps
+        exclaim "Setting up Picky #{type} \"#{name}\"."
+        
+        create_target_directory
+        copy_all_files
+        
+        prototype_paths.each do |path|
+          copy_all_files expand_prototype_path(path)
+        end
+        
+        exclaim "\"#{name}\" is a great project name! Have fun :)\n"
+        exclaim ""
+        exclaim "Next steps:"
+        
+        steps.each.with_index do |step, i|
+          exclaim "#{i+1}. #{step}"
+        end
+      end
+      
     end
     
   end

data/lib/picky-generators/generators/client/sinatra.rb

@@ -18,19 +18,19 @@ module Picky
         #
         #
         def generate
-          exclaim "Setting up Picky Sinatra Client \"#{name}\"."
-          create_target_directory
-          copy_all_files
-          copy_all_files expand_prototype_path('shared/both')
-          copy_all_files expand_prototype_path('shared/client')
-          exclaim "\"#{name}\" is a great project name! Have fun :)\n"
-          exclaim ""
-          exclaim "Next steps:"
-          exclaim "1. cd #{name}"
-          exclaim "2. bundle install"
-          exclaim "3. unicorn -p 3000 # (optional) Or use your favorite web server."
-          exclaim "4. open http://localhost:3000"
-          exclaim ""
+          generate_for "Sinatra Client",
+          [
+            'shared/both',
+            'shared/client'
+          ],
+          [
+            "cd #{name}",
+            "bundle install",
+            "rake index",
+            "unicorn -p 3000 # (optional) Or use your favorite web server.",
+            "open http://localhost:3000/",
+            "rake todo # (optional) Shows you where Picky needs input from you."
+          ]
         end
 
       end

data/lib/picky-generators/generators/server/sinatra.rb

@@ -18,19 +18,19 @@ module Picky
         #
         #
         def generate
-          exclaim "Setting up Picky Sinatra Server \"#{name}\"."
-          create_target_directory
-          copy_all_files
-          copy_all_files expand_prototype_path('shared/server')
-          copy_all_files expand_prototype_path('shared/both')
-          exclaim "\"#{name}\" is a great project name! Have fun :)\n"
-          exclaim ""
-          exclaim "Next steps:"
-          exclaim "1. cd #{name}"
-          exclaim "2. rake index"
-          exclaim "3. unicorn -c unicorn.rb"
-          exclaim "4. rake todo      # (optional) shows you where Picky needs input from you"
-          exclaim "                  #            if you want to define your own search."
+          generate_for "Sinatra Server",
+          [
+            'shared/server',
+            'shared/both'
+          ],
+          [
+            "cd #{name}",
+            "bundle install",
+            "rake index",
+            "unicorn -c unicorn.rb",
+            "curl http://localhost:8080/books?query=turing",
+            "rake todo # (optional) Shows you where Picky needs input from you."
+          ]
         end
 
       end

data/prototypes/all_in_one/sinatra/app.rb

@@ -6,9 +6,10 @@ require 'haml'
 require 'csv'
 require 'picky'
 require 'picky-client'
-
-require File.expand_path '../book',    __FILE__
-require File.expand_path '../logging', __FILE__
+require_relative 'book'
+require_relative 'logging'
+require_relative 'books_index'
+require_relative 'books_search'
 
 # This app shows how to integrate the Picky server directly
 # inside a web app. However, if you really need performance
@@ -16,68 +17,6 @@ require File.expand_path '../logging', __FILE__
 #
 class BookSearch < Sinatra::Application
 
-  # We do this so we don't have to type
-  # Picky:: in front of everything.
-  #
-  include Picky
-
-
-  # Server.
-  #
-
-  # Data source.
-  #
-  class Books
-
-    def initialize
-      @csv = CSV.new File.open(File.expand_path("../data/#{PICKY_ENVIRONMENT}/library.csv", __FILE__))
-    end
-
-    def each
-      instance = Struct.new :id, :title, :author, :year
-      @csv.each do |row|
-        yield instance.new *row[0..3]
-      end
-    end
-
-  end
-
-  # Define an index.
-  #
-  books_index = Index.new :books do
-    source { Books.new }
-    indexing removes_characters: /[^a-z0-9\s\/\-\_\:\"\&\.]/i,
-             stopwords:          /\b(and|the|of|it|in|for)\b/i,
-             splits_text_on:     /[\s\/\-\_\:\"\&\.]/
-    category :title,
-             similarity: Similarity::DoubleMetaphone.new(3),
-             partial: Partial::Substring.new(from: 1) # Default is from: -3.
-    category :author, partial: Partial::Substring.new(from: 1)
-    category :year, partial: Partial::None.new
-  end
-
-  # Index and load on USR1 signal.
-  #
-  Signal.trap('USR1') do
-    books_index.reindex # kill -USR1 <pid>
-  end
-
-  # Define a search over the books index.
-  #
-  books = Search.new books_index do
-    searching substitutes_characters_with: CharacterSubstituters::WestEuropean.new, # Normalizes special user input, Ä -> Ae, ñ -> n etc.
-              removes_characters: /[^\p{L}\p{N}\s\/\-\_\&\.\"\~\*\:\,]/i, # Picky needs control chars *"~:, to pass through.
-              stopwords:          /\b(and|the|of|it|in|for)\b/i,
-              splits_text_on:     /[\s\/\-\&]+/
-
-    boost [:title, :author] => +3,
-          [:title]          => +1
-  end
-
-
-  # Client.
-  #
-
   set :static,        true
   set :public_folder, File.dirname(__FILE__)
   set :views,         File.expand_path('../views', __FILE__)
@@ -97,7 +36,7 @@ class BookSearch < Sinatra::Application
   # populate the result hash with rendered models.
   #
   get '/search/full' do
-    results = books.search params[:query], params[:ids] || 20, params[:offset] || 0
+    results = BooksSearch.search params[:query], params[:ids] || 20, params[:offset] || 0
     Picky.logger.info results
     results = results.to_hash
     results.extend Picky::Convenience
@@ -119,16 +58,8 @@ class BookSearch < Sinatra::Application
   # Updates the search count while the user is typing.
   #
   get '/search/live' do
-    results = books.search params[:query], params[:ids] || 20, params[:offset] || 0
+    results = BooksSearch.search params[:query], params[:ids] || 20, params[:offset] || 0
     results.to_json
   end
 
-  helpers do
-
-    def js path
-      "<script src='javascripts/#{path}.js' type='text/javascript'></script>"
-    end
-
-  end
-
 end

data/prototypes/all_in_one/sinatra/views/search.haml

@@ -1,13 +1,12 @@
 !!!
 %html{ :lang => 'en' }
   %head
-    %link{:href => "stylesheets/application.css", :media => "screen", :rel => "stylesheet", :type => "text/css"}/
-    %link{:href => "stylesheets/picky.css", :media => "screen", :rel => "stylesheet", :type => "text/css"}/
-    = js 'jquery-1.5.0.min'
-    = js 'history.min'
-    = js 'history.adapter.jquery.min'
-    = js 'picky.min'
-
+    %link{ :href => "stylesheets/application.css", :media => "screen", :rel => "stylesheet", :type => "text/css" }/
+    %link{ :href => "stylesheets/picky.css", :media => "screen", :rel => "stylesheet", :type => "text/css" }/
+    %script{ :src => 'javascripts/jquery-1.5.0.min.js', :type => 'text/javascript' }
+    %script{ :src => 'javascripts/history.min.js', :type => 'text/javascript' }
+    %script{ :src => 'javascripts/history.adapter.jquery.min.js', :type => 'text/javascript' }
+    %script{ :src => 'javascripts/picky.min.js', :type => 'text/javascript' }
   %body
     %hgroup
       / Replace these headers with your code

data/prototypes/client/sinatra/app.rb

@@ -49,12 +49,4 @@ end
 #
 get '/search/live' do
   BooksSearch.search_unparsed params[:query], :offset => params[:offset]
-end
-
-helpers do
-
-  def js path
-    "<script src='javascripts/#{path}.js' type='text/javascript'></script>"
-  end
-
 end

data/prototypes/client/sinatra/views/search.haml

@@ -1,13 +1,12 @@
 !!!
 %html{ :lang => 'en' }
   %head
-    %link{:href => "stylesheets/application.css", :media => "screen", :rel => "stylesheet", :type => "text/css"}/
-    %link{:href => "stylesheets/picky.css", :media => "screen", :rel => "stylesheet", :type => "text/css"}/
-    = js 'jquery-1.5.0.min'
-    = js 'history.min'
-    = js 'history.adapter.jquery.min'
-    = js 'picky.min'
-
+    %link{ :href => "stylesheets/application.css", :media => "screen", :rel => "stylesheet", :type => "text/css" }/
+    %link{ :href => "stylesheets/picky.css", :media => "screen", :rel => "stylesheet", :type => "text/css" }/
+    %script{ :src => 'javascripts/jquery-1.5.0.min.js', :type => 'text/javascript' }
+    %script{ :src => 'javascripts/history.min.js', :type => 'text/javascript' }
+    %script{ :src => 'javascripts/history.adapter.jquery.min.js', :type => 'text/javascript' }
+    %script{ :src => 'javascripts/picky.min.js', :type => 'text/javascript' }
   %body
     %hgroup
       / Replace these headers with your code

data/prototypes/server/sinatra/app.rb

@@ -3,67 +3,16 @@
 require 'sinatra/base'
 require 'csv'
 require 'picky'
-require File.expand_path '../logging', __FILE__
+require_relative 'logging'
+require_relative 'books_index'
+require_relative 'books_search'
 
 class BookSearch < Sinatra::Application
 
-  # We do this so we don't have to type
-  # Picky:: in front of everything.
-  #
-  include Picky
-
-  # Data source.
-  #
-  class Books
-
-    def initialize
-      @csv = CSV.new File.open(File.expand_path("../data/#{PICKY_ENVIRONMENT}/library.csv", __FILE__))
-    end
-
-    def each
-      instance = Struct.new :id, :title, :author, :year
-      @csv.each do |row|
-        yield instance.new *row[0..3]
-      end
-    end
-
-  end
-
-  # Define an index.
-  #
-  books_index = Index.new :books do
-    source   { Books.new }
-    indexing removes_characters: /[^a-z0-9\s\/\-\_\:\"\&\.]/i,
-             stopwords:          /\b(and|the|of|it|in|for)\b/i,
-             splits_text_on:     /[\s\/\-\_\:\"\&\.]/
-    category :title,
-             similarity: Similarity::DoubleMetaphone.new(3),
-             partial: Partial::Substring.new(from: 1) # Default is from: -3.
-    category :author, partial: Partial::Substring.new(from: 1)
-    category :year, partial: Partial::None.new
-  end
-
-  # Index and load on USR1 signal.
-  #
-  Signal.trap('USR1') do
-    books_index.reindex # kill -USR1 <pid>
-  end
-
-  # Define a search over the books index.
-  #
-  books = Search.new books_index do
-    searching substitutes_characters_with: CharacterSubstituters::WestEuropean.new, # Normalizes special user input, Ä -> Ae, ñ -> n etc.
-              removes_characters: /[^\p{L}\p{N}\s\/\-\_\&\.\"\~\*\:\,]/i, # Picky needs control chars *"~:, to pass through.
-              stopwords:          /\b(and|the|of|it|in|for)\b/i,
-              splits_text_on:     /[\s\/\-\&]+/
-    boost [:title, :author] => +3,
-          [:title]          => +1
-  end
-
   # Route /books to the books search and log when searching.
   #
   get '/books' do
-    results = books.search params[:query], params[:ids] || 20, params[:offset] || 0
+    results = BooksSearch.search params[:query], params[:ids] || 20, params[:offset] || 0
     Picky.logger.info results
     results.to_json
   end

data/prototypes/shared/server/books_index.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+#
+
+# Data source.
+#
+class Books
+
+  def initialize
+    @csv = CSV.new File.open(File.expand_path("../data/#{PICKY_ENVIRONMENT}/library.csv", __FILE__))
+  end
+
+  def each
+    instance = Struct.new :id, :title, :author, :year
+    @csv.each do |row|
+      yield instance.new *row[0..3]
+    end
+  end
+
+end
+
+# Define an index.
+#
+BooksIndex = Picky::Index.new :books do
+  source { Books.new }
+  indexing removes_characters: /[^a-z0-9\s\/\-\_\:\"\&\.]/i,
+           stopwords:          /\b(and|the|of|it|in|for)\b/i,
+           splits_text_on:     /[\s\/\-\_\:\"\&\.]/
+  category :title,
+           similarity: Picky::Similarity::DoubleMetaphone.new(3),
+           partial: Picky::Partial::Substring.new(from: 1) # Default is from: -3.
+  category :author, partial: Picky::Partial::Substring.new(from: 1)
+  category :year, partial: Picky::Partial::None.new
+end
+
+# Index and load on USR1 signal.
+#
+Signal.trap('USR1') do
+  BooksIndex.reindex # kill -USR1 <pid>
+end

data/prototypes/shared/server/books_search.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+#
+
+# Define a search over the books index.
+#
+BooksSearch = Picky::Search.new BooksIndex do
+            # Normalizes special user input, Ä -> Ae, ñ -> n etc.
+  searching substitutes_characters_with: Picky::CharacterSubstituters::WestEuropean.new,
+            # Picky needs control chars *"~:, to pass through.
+            removes_characters: /[^\p{L}\p{N}\s\/\-\_\&\.\"\~\*\:\,]/i,
+            stopwords:          /\b(and|the|of|it|in|for)\b/i,
+            splits_text_on:     /[\s\/\-\&]+/
+
+  boost [:title, :author] => +3,
+        [:title]          => +1
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: picky-generators
 version: !ruby/object:Gem::Version
-  version: 4.12.1
+  version: 4.12.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-26 00:00:00.000000000 Z
+date: 2012-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.12.1
+        version: 4.12.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.12.1
+        version: 4.12.2
 - !ruby/object:Gem::Dependency
   name: picky-client
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.12.1
+        version: 4.12.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.12.1
+        version: 4.12.2
 description: Generators for Picky.
 email: florian.hanke+picky-generators@gmail.com
 executables:
@@ -110,6 +110,8 @@ files:
 - prototypes/shared/both/data/production/library.csv
 - prototypes/shared/both/data/test/library.csv
 - prototypes/shared/client/book.rb
+- prototypes/shared/server/books_index.rb
+- prototypes/shared/server/books_search.rb
 - prototypes/shared/server/config.ru
 - prototypes/shared/server/logging.rb
 - prototypes/shared/server/spec/spec_helper.rb