picky-generators 3.0.0.pre3 → 3.0.0.pre4

data/prototypes/all_in_one/sinatra/logging.rb

@@ -0,0 +1,24 @@
+# Separate file since this is usually what is
+# environment specific.
+# (But go ahead and place the code in app.rb if you wish)
+#
+
+# Standard logging.
+#
+require 'logger'
+AppLogger = Logger.new File.expand_path('log/search.log', PICKY_ROOT)
+
+# Example with using the syslog logger.
+# Falling back to the standard log if it isn't available.
+# (For example, because it is used locally and syslog is
+# only available on the servers)
+#
+# begin
+#   log_program_name = 'search/query'
+#   AppLogger        = SyslogLogger.new log_program_name
+#   puts "Logging on syslog #{log_program_name}."
+# rescue StandardError
+#   puts "Could not connect to the syslog, using the normal log."
+#   require 'logger'
+#   AppLogger = Logger.new(File.join(PICKY_ROOT, 'log/search.log'))
+# end

data/prototypes/all_in_one/sinatra/stylesheets/application.css

@@ -0,0 +1,22 @@
+body {
+  text-align: center;
+  font-family: Lucida Grande; }
+  body .content {
+    width: 560px;
+    margin: 0 auto;
+    text-align: left; }
+
+img {
+  margin: 0px 0px -210px; }
+
+p span.explanation {
+  color: #999999; }
+
+pre {
+  padding: 10px;
+  background-color: #efede5; }
+
+#picky ol.results li.book {
+  background-color: #ffeeee;
+  padding: 5px 25px;
+  margin: 3px 0px; }

data/prototypes/all_in_one/sinatra/stylesheets/picky.css

@@ -0,0 +1,135 @@
+#picky {
+  overflow: hidden; }
+  #picky > div.header {
+    display: none; }
+  #picky div.dashboard {
+    position: relative;
+    overflow: hidden;
+    background-color: lightGrey;
+    padding: 5px 5px 7px 5px;
+    height: 26px;
+    margin-bottom: 3px; }
+    #picky div.dashboard.empty .status {
+      background-color: #8cacda; }
+    #picky div.dashboard.empty .feedback {
+      background-color: #d0e2ff; }
+    #picky div.dashboard.none .status {
+      background-color: red; }
+    #picky div.dashboard.none .feedback {
+      background-color: #ffdddd; }
+    #picky div.dashboard.support .status {
+      background-color: #ff6600; }
+    #picky div.dashboard.support .feedback {
+      background-color: #faf3d0; }
+    #picky div.dashboard.ok .status {
+      background-color: #09be01; }
+    #picky div.dashboard.ok .feedback {
+      background-color: #bcf0b3; }
+    #picky div.dashboard .feedback {
+      width: 85%;
+      float: left;
+      border: 1px solid #cccccc;
+      padding: 0;
+      margin: 0; }
+      #picky div.dashboard .feedback .status {
+        float: left;
+        width: 45px;
+        height: 26px;
+        line-height: 26px;
+        text-align: center;
+        padding: 0 0 0 2px;
+        font-weight: bold;
+        color: white;
+        margin-right: 5px; }
+      #picky div.dashboard .feedback .status.alert {
+        background-color: lightgreen; }
+      #picky div.dashboard .feedback input.query {
+        float: left;
+        width: 80%;
+        height: 100%;
+        font-size: 1em;
+        font-weight: bold;
+        border-style: solid;
+        border-width: 0px 0px 3px 0px;
+        border-color: transparent;
+        margin: 0;
+        padding: 4px 0 0 0;
+        outline: none;
+        background: none; }
+      #picky div.dashboard .feedback .reset {
+        float: right;
+        width: 18px;
+        height: 18px;
+        margin: 3px 3px 0px 0px;
+        cursor: pointer;
+        opacity: 0; }
+    #picky div.dashboard input.search_button {
+      margin: 5px 0px 5px 2%; }
+  #picky div.results {
+    margin-top: 0px;
+    padding: 0px; }
+    #picky div.results div.header, #picky div.results div.addination {
+      color: #555555;
+      background-color: #eeeeee;
+      padding: 6px 5px 5px 8px; }
+      #picky div.results div.header .tothetop, #picky div.results div.addination .tothetop {
+        float: right; }
+        #picky div.results div.header .tothetop a, #picky div.results div.addination .tothetop a {
+          display: block;
+          width: 20px;
+          height: 20px; }
+    #picky div.results ol.results {
+      list-style-type: none;
+      padding: 0px;
+      margin: 0px; }
+    #picky div.results div.addination {
+      position: relative;
+      text-align: center;
+      color: #276abb;
+      cursor: pointer; }
+  #picky .no_results {
+    display: none; }
+  #picky .allocations {
+    clear: both;
+    overflow: hidden;
+    background-color: white;
+    padding-bottom: 2px; }
+    #picky .allocations ol.hidden {
+      display: none; }
+    #picky .allocations ol.more:hover {
+      background-color: #cccccc;
+      cursor: pointer; }
+    #picky .allocations ol.more {
+      background-color: #eeeeee;
+      display: none;
+      text-align: center;
+      height: 32px;
+      line-height: 32px; }
+      #picky .allocations ol.more li {
+        text-align: center; }
+    #picky .allocations ol {
+      list-style-position: outside;
+      list-style: none;
+      padding: 0;
+      margin: 0px;
+      overflow: hidden; }
+      #picky .allocations ol li {
+        margin: 0px;
+        margin-bottom: 3px;
+        padding: 10px 13px;
+        cursor: pointer;
+        display: block;
+        font: menu;
+        font-size: 1em;
+        line-height: 16px;
+        background-color: #f3f3f3;
+        overflow: hidden;
+        color: #276abb; }
+        #picky .allocations ol li .text {
+          max-width: 90%;
+          float: left; }
+        #picky .allocations ol li .count {
+          float: right;
+          color: #cccccc; }
+      #picky .allocations ol li:hover {
+        background-color: #d0e2ff; }

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

@@ -0,0 +1,162 @@
+!!!
+%html{ :lang => 'en' }
+  %head
+    %link{:href => "stylesheets/stylesheet.css", :media => "screen", :rel => "stylesheet", :type => "text/css"}/
+  %body
+    %img{:src => "images/picky.png"}/
+    %p
+      %a{:href => "http://floere.github.com/picky"} To the Picky Homepage
+      \/
+      %a{:href => '/' } Back to the example
+    .content
+      %h1 Already made it this far? You're good!
+      %p I think you're ready for configuring me for your own purposes.
+      %h2 Configuring the Picky client.
+      %p
+        There are two places where you configure the Picky client:
+        %ol
+          %li
+            %a{ :href => '#controller' } In the controller.
+            (client to Picky server)
+          %li
+            %a{ :href => '#view' } In the view.
+            (javascript client interface)
+      %h2#controller Controller
+      %p
+        Open the file
+        %strong app.rb
+        and take a peek inside.
+      %p
+        First you need a client instance.
+      %p
+        In the example, I called it
+        %strong BookSearch
+        respectively.
+        %code
+          %pre
+            :preserve
+              BookSearch = Picky::Client.new :host => 'localhost', :port => 8080, :path => '/books'
+      %p
+        Both clients offer the options:
+        %dl
+          %dt
+            %strong host
+          %dd The Picky search server host.
+          %dt
+            %strong port
+          %dd The Picky search server port (see unicorn.rb in the server).
+          %dt
+            %strong path
+          %dd The Picky search path (see app/application.rb in the server for the mapping path => query).
+      %p
+        Then, use these Client instances in your actions. For example like this:
+        %code
+          %pre
+            :preserve
+              get '/search/full' do
+                results = BookSearch.search params[:query], :ids => params[:ids], :offset => params[:offset]
+                results.extend Picky::Convenience
+                results.populate_with Book do |book|
+                  book.to_s
+                end
+                ActiveSupport::JSON.encode results
+              end
+      %p
+        This part gets a
+        %strong hash
+        with the results:
+        %code
+          %pre results = BookSearch.search params[:query], :ids => params[:ids], :offset => params[:offset]
+      %p
+        This part takes the
+        %strong hash
+        and extends it with a few useful and convenient methods:
+        %code
+          %pre results.extend Picky::Convenience
+      %p
+        One of these methods is the
+        %strong populate_with
+        method which takes a
+        %strong model
+        as parameter, and then gets the corresponding
+        %strong model instances
+        for each id in the result.
+        %code
+          %pre
+            :preserve
+              results.populate_with Book do |book|
+                book.to_s
+              end
+        The
+        %strong book.to_s
+        simulates rendering a book.
+        You can do whatever with the book instance if you just return a rendered thing that's supposed to be shown in the front end.
+      %p
+        If you don't want to render in the controller, you can do so in a view. In the controller just call
+        %code
+          %pre
+            results.populate_with Book
+        and then render the books in a view using:
+        %code
+          %pre
+            :preserve
+              results.entries do |book|
+                render book # or book.to_s, or however you like to render the book.
+              end
+      %p
+        At the end, encode the hash in JSON:
+        %code
+          %pre
+            ActiveSupport::JSON.encode results
+        That's it for the controller.
+      %p
+        All the steps in one:
+        %code
+          %pre
+            :preserve
+              BookSearch = Picky::Client.new :host => 'localhost', :port => 8080, :path => '/books'
+
+              get '/search/full' do
+                results = BookSearch.search params[:query], :ids => params[:ids], :offset => params[:offset]
+
+                results.extend Picky::Convenience
+                results.populate_with Book do |book|
+                  book.to_s
+                end
+
+                ActiveSupport::JSON.encode results
+              end
+      %h2#view View
+      %p
+        The view is even easier. Just add the line
+        %code
+          %pre
+            \= Picky::Helper.cached_interface
+        if you use just one language, or
+        %code
+          %pre
+            \= Picky::Helper.interface :button => 'search', :no_results => 'No results!', :more => 'more'
+        if you use multiple languages.
+        (You'd use the options
+        %pre :button => t(:'search.button'), :no_results => t(:'search.no_results'), :more => t(:'search.more')
+        of course, with proper i18n)
+        The same options can be used for
+        %strong #cached_interface
+        but they will be cached, so you can only set them once and then reused.
+      %p
+        You're almost finished. Take a look at the file
+        %strong views/search.haml
+        where you'll find javascript at the end. It looks something like this:
+        %code
+          %pre
+            :preserve
+              :javascript
+                pickyClient = new PickyClient({
+                  // A full query displays the rendered results.
+                  //
+                  full: '/search/full',
+
+                  // etc.
+        Just take a look at the possible javascript client options in that file.
+      %p
+        %strong Good luck my friend! *waves several stubby pink tentacles*

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

@@ -0,0 +1,138 @@
+!!!
+%html{ :lang => 'en' }
+  %head
+    %link{:href => "stylesheets/picky.css", :media => "screen", :rel => "stylesheet", :type => "text/css"}/
+    %link{:href => "stylesheets/application.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'
+
+  %body
+    %img{:src => "images/picky.png"}/
+    %p
+      %a{:href => "http://floere.github.com/picky"} To the Picky Homepage
+      \/
+      %a{:href => '/configure' } Configuring this app server
+    %p
+      Try a few examples
+      = succeed ":" do
+        %span.explanation (on a simple database with 540 books - note that the server is on Heroku and needs a little time to ramp up)
+    %p
+      A simple word,
+      = succeed "." do
+        %a{:href => "#", :onclick => "pickyClient.insert('alan');"} alan
+      %span.explanation
+        (Finds Alan in the title, and Alans who wrote books. The title is ranked higher due to weighing.)
+        %span
+    %p
+      With qualifier,
+      = succeed "." do
+        %a{:href => "#", :onclick => "pickyClient.insert('title:women');"} title:women
+      %span.explanation
+        (Finds "women*" just in titles.)
+        %span
+    %p
+      With similarity,
+      = succeed "." do
+        %a{:href => "#", :onclick => "pickyClient.insert('pinchn~');"} pinchn~
+      %span.explanation (Finds "pynchon", note: Only title in example with similarity. Uses a combination of double metaphone and Levenshtein.)
+    %p
+      More complex,
+      = succeed "." do
+        %a{:href => "#", :onclick => "pickyClient.insert('title:lyterature~');"} title:lyterature~
+      %span.explanation (Finds similar titles)
+    %p
+      With choice,
+      = succeed "." do
+        %a{:href => "#", :onclick => "pickyClient.insert('sp');"} sp
+      %span.explanation (Finds "sp*" in multiple categories. Choose the one you're looking for.)
+    %p
+      More complex,
+      = succeed "." do
+        %a{:href => "#", :onclick => "pickyClient.insert('soc* p');"} soc* p
+      %span.explanation (This is where Picky really shines, "the title started with soc, and the author starts with p")
+    .content
+      = Picky::Helper.cached_interface
+      :javascript
+        $(window).load(function() {
+          pickyClient = new PickyClient({
+            // A full query displays the rendered results.
+            //
+            full: '/search/full',
+            // fullResults: 100, // Optional. Amount of ids to search for, default 20.
+
+            // A live query just updates the count and does not need
+            // to render (could go straight to the search server).
+            //
+            live: '/search/live',
+            // liveResults: 0, // Optional. Amount of ids to search for, default 0.
+
+            // showResultsLimit: 10, // Optional. Default is 10.
+
+            // Wrap each li group (like author-title, or title-isbn etc.) of results
+            // in this element.
+            // Optional. Default is '<ol class="results"></ol>'.
+            //
+            // wrapResults: '<div class="hello"><ol class="world"></ol></div>',
+
+            // before: function(params, query) {  }, // Optional. Before Picky sends any data.
+            // success: function(data, query) {  }, // Optional. Just after Picky receives data. (Get a PickyData object)
+            // after: function(data, query) {  }, // Optional. After Picky has handled the data and updated the view.
+
+            // This is used to generate the correct query strings, localized. E.g. "subject:war".
+            // Optional. If you don't give these, the field identifier given in the Picky server is used.
+            //
+            qualifiers: {
+              en:{
+                subjects:  'subject'
+              }
+            },
+
+            // Use this to group the choices (those are used when Picky needs more feedback).
+            // If a category is missing, it is appended in a virtual group at the end.
+            // Optional. Default is [].
+            //
+            groups: [['author', 'title', 'subjects']],
+            // This is used for formatting inside the choice groups.
+            //
+            // Use %n$s, where n is the position of the category in the key.
+            // Optional. Default is {}.
+            //
+            choices: {
+              en:{
+                'title': {
+                  format: "<strong>%1$s</strong>",
+                  filter: function(text) { return text.toUpperCase(); },
+                  ignoreSingle: false
+                },
+                'author,title':    '%1$s, who wrote %2$s',
+                'title,author':    '%2$s, written by %2$s',
+                'title,subjects': '%1$s, about %2$s',
+                'author,subjects': '%1$s, who wrote about %2$s'
+              }
+            },
+
+            // This is used to explain the preceding word in the suggestion text (if it
+            // has not yet been defined by the choices above), localized. E.g. "Peter (author)".
+            // Optional. Default are the field identifiers from the Picky server.
+            //
+            explanations: {
+              en:{
+                title:     'titled',
+                author:    'written by',
+                year:      'published in'
+                // publisher: 'published by',
+                // subjects:  'topics'
+              }
+            }
+          });
+
+          // An initial search text, prefilled
+          // this one is passed through the query param q.
+          //
+          // Example: www.mysearch.com/?q=example
+          //
+          pickyClient.insertFromURL('#{@query}');
+        });

data/prototypes/client/sinatra/Gemfile

@@ -2,7 +2,7 @@ source :gemcutter
 
 # Gems required by the Picky client.
 #
-gem 'picky-client', '3.0.0.pre3' # '~> 3.0'
+gem 'picky-client', '3.0.0.pre4' # '~> 3.0'
 gem 'i18n'
 gem 'activesupport', :require => 'active_support/core_ext'
 gem 'sinatra'

data/prototypes/client/sinatra/app.rb

@@ -6,12 +6,12 @@ Bundler.require
 #
 set :static, true
 set :public, File.dirname(__FILE__)
-set :views,  File.expand_path('views', File.dirname(__FILE__))
+set :views,  File.expand_path('../views', __FILE__)
 set :haml,   :format => :html5
 
 # Load the simplified "model".
 #
-require File.expand_path 'book', File.dirname(__FILE__)
+require File.expand_path '../book', __FILE__
 
 # Sets up a search instance to the server.
 #

data/prototypes/server/classic/Gemfile

@@ -2,7 +2,7 @@ source :gemcutter
 
 # Gems required by Picky.
 #
-gem 'picky', '3.0.0.pre3' # '~> 3.0'
+gem 'picky', '3.0.0.pre4' # '~> 3.0'
 gem 'rake'
 gem 'rack'
 gem 'rack-mount'
@@ -22,6 +22,6 @@ gem 'mysql' # Project specific.
 gem 'redis' # Project specific.
 
 group :test do
-  gem 'picky-client', '3.0.0.pre2'
+  gem 'picky-client', '3.0.0.pre4'
   gem 'rspec'
 end

data/prototypes/server/sinatra/Gemfile

@@ -2,7 +2,7 @@ source :gemcutter
 
 # Gems required by Picky.
 #
-gem 'picky', '3.0.0.pre3' # '~> 3.0'
+gem 'picky', '3.0.0.pre4' # '~> 3.0'
 gem 'rake'
 gem 'rack'
 gem 'rack_fast_escape', '2009.06.24' # Optional.
@@ -22,6 +22,6 @@ gem 'mysql' # Project specific.
 gem 'redis' # Project specific.
 
 group :test do
-  gem 'picky-client', '3.0.0.pre3'
+  gem 'picky-client', '3.0.0.pre4'
   gem 'rspec'
 end

data/prototypes/server/sinatra/config.ru

@@ -11,4 +11,4 @@ Picky::Indexes.reload
 # Rack::Harakiri.after = 1000
 # use Rack::Harakiri
 
-run BookSearch.new
+run BookSearch

data/spec/lib/picky-generators/generators/selector_spec.rb

@@ -15,6 +15,9 @@ describe Picky::Generators::Selector do
     end
     
     describe "generator_for" do
+      it "should not raise if a generator is available" do
+        lambda { @selector.generator_for('all_in_one', 'some_project') }.should_not raise_error
+      end
       it "should not raise if a generator is available" do
         lambda { @selector.generator_for('sinatra_client', 'some_project') }.should_not raise_error
       end

metadata

@@ -2,7 +2,7 @@
 name: picky-generators
 version: !ruby/object:Gem::Version 
   prerelease: 6
-  version: 3.0.0.pre3
+  version: 3.0.0.pre4
 platform: ruby
 authors: 
 - Florian Hanke
@@ -32,7 +32,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 3.0.0.pre3
+        version: 3.0.0.pre4
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -43,7 +43,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 3.0.0.pre3
+        version: 3.0.0.pre4
   type: :runtime
   version_requirements: *id003
 description: Generators for Picky.
@@ -55,6 +55,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/picky-generators/generators/all_in_one/sinatra.rb
 - lib/picky-generators/generators/base.rb
 - lib/picky-generators/generators/client/sinatra.rb
 - lib/picky-generators/generators/not_found_exception.rb
@@ -62,6 +63,23 @@ files:
 - lib/picky-generators/generators/server/classic.rb
 - lib/picky-generators/generators/server/sinatra.rb
 - lib/picky-generators.rb
+- prototypes/all_in_one/sinatra/app.rb
+- prototypes/all_in_one/sinatra/book.rb
+- prototypes/all_in_one/sinatra/config.ru
+- prototypes/all_in_one/sinatra/Gemfile
+- prototypes/all_in_one/sinatra/images/picky.png
+- prototypes/all_in_one/sinatra/javascripts/history.adapter.jquery.min.js
+- prototypes/all_in_one/sinatra/javascripts/history.min.js
+- prototypes/all_in_one/sinatra/javascripts/jquery-1.5.0.min.js
+- prototypes/all_in_one/sinatra/javascripts/picky.min.js
+- prototypes/all_in_one/sinatra/library.csv
+- prototypes/all_in_one/sinatra/log/README
+- prototypes/all_in_one/sinatra/logging.rb
+- prototypes/all_in_one/sinatra/Rakefile
+- prototypes/all_in_one/sinatra/stylesheets/application.css
+- prototypes/all_in_one/sinatra/stylesheets/picky.css
+- prototypes/all_in_one/sinatra/views/configure.haml
+- prototypes/all_in_one/sinatra/views/search.haml
 - prototypes/client/sinatra/app.rb
 - prototypes/client/sinatra/book.rb
 - prototypes/client/sinatra/config.ru