dm-is-published 0.0.6 → 1.2.0

data/docs/js/searcher.js

@@ -0,0 +1,228 @@
+Searcher = function(data) {
+  this.data = data;
+  this.handlers = [];
+}
+
+Searcher.prototype = new function() {
+  // search is performed in chunks of 1000 for non-blocking user input
+  var CHUNK_SIZE = 1000;
+  // do not try to find more than 100 results
+  var MAX_RESULTS = 100;
+  var huid = 1;
+  var suid = 1;
+  var runs = 0;
+
+  this.find = function(query) {
+    var queries = splitQuery(query);
+    var regexps = buildRegexps(queries);
+    var highlighters = buildHilighters(queries);
+    var state = { from: 0, pass: 0, limit: MAX_RESULTS, n: suid++};
+    var _this = this;
+
+    this.currentSuid = state.n;
+
+    if (!query) return;
+
+    var run = function() {
+      // stop current search thread if new search started
+      if (state.n != _this.currentSuid) return;
+
+      var results =
+        performSearch(_this.data, regexps, queries, highlighters, state);
+      var hasMore = (state.limit > 0 && state.pass < 4);
+
+      triggerResults.call(_this, results, !hasMore);
+      if (hasMore) {
+        setTimeout(run, 2);
+      }
+      runs++;
+    };
+    runs = 0;
+
+    // start search thread
+    run();
+  }
+
+  /*  ----- Events ------  */
+  this.ready = function(fn) {
+    fn.huid = huid;
+    this.handlers.push(fn);
+  }
+
+  /*  ----- Utilities ------  */
+  function splitQuery(query) {
+    return jQuery.grep(query.split(/(\s+|::?|\(\)?)/), function(string) {
+      return string.match(/\S/)
+    });
+  }
+
+  function buildRegexps(queries) {
+    return jQuery.map(queries, function(query) {
+      return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i')
+    });
+  }
+
+  function buildHilighters(queries) {
+    return jQuery.map(queries, function(query) {
+      return jQuery.map(query.split(''), function(l, i) {
+        return '\u0001$' + (i*2+1) + '\u0002$' + (i*2+2);
+      }).join('');
+    });
+  }
+
+  // function longMatchRegexp(index, longIndex, regexps) {
+  //     for (var i = regexps.length - 1; i >= 0; i--){
+  //         if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) return false;
+  //     };
+  //     return true;
+  // }
+
+
+  /*  ----- Mathchers ------  */
+
+  /*
+   * This record matches if the index starts with queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassBeginning(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if the longIndex starts with queries[0] and the
+   * longIndex matches all of the regexps
+   */
+  function matchPassLongIndex(index, longIndex, queries, regexps) {
+    if (longIndex.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if the index contains queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassContains(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) == -1) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if regexps[0] matches the index and the record
+   * matches all of the regexps
+   */
+  function matchPassRegexp(index, longIndex, queries, regexps) {
+    if (!index.match(regexps[0])) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+
+  /*  ----- Highlighters ------  */
+  function highlightRegexp(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    for (var i=0, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+
+  function hltSubstring(string, pos, length) {
+    return string.substring(0, pos) + '\u0001' + string.substring(pos, pos + length) + '\u0002' + string.substring(pos + length);
+  }
+
+  function highlightQuery(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    var pos = 0;
+    var lcTitle = result.title.toLowerCase();
+
+    pos = lcTitle.indexOf(queries[0]);
+    if (pos != -1) {
+      result.title = hltSubstring(result.title, pos, queries[0].length);
+    }
+
+    result.namespace = result.namespace.replace(regexps[0], highlighters[0]);
+    for (var i=1, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+
+  function createResult(info) {
+    var result = {};
+    result.title = info[0];
+    result.namespace = info[1];
+    result.path = info[2];
+    result.params = info[3];
+    result.snippet = info[4];
+    return result;
+  }
+
+  /*  ----- Searching ------  */
+  function performSearch(data, regexps, queries, highlighters, state) {
+    var searchIndex = data.searchIndex;
+    var longSearchIndex = data.longSearchIndex;
+    var info = data.info;
+    var result = [];
+    var i = state.from;
+    var l = searchIndex.length;
+    var togo = CHUNK_SIZE;
+    var matchFunc, hltFunc;
+
+    while (state.pass < 4 && state.limit > 0 && togo > 0) {
+      if (state.pass == 0) {
+        matchFunc = matchPassBeginning;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 1) {
+        matchFunc = matchPassLongIndex;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 2) {
+        matchFunc = matchPassContains;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 3) {
+        matchFunc = matchPassRegexp;
+        hltFunc = highlightRegexp;
+      }
+
+      for (; togo > 0 && i < l && state.limit > 0; i++, togo--) {
+        if (info[i].n == state.n) continue;
+        if (matchFunc(searchIndex[i], longSearchIndex[i], queries, regexps)) {
+          info[i].n = state.n;
+          result.push(hltFunc(info[i], queries, regexps, highlighters));
+          state.limit--;
+        }
+      };
+      if (searchIndex.length <= i) {
+        state.pass++;
+        i = state.from = 0;
+      } else {
+        state.from = i;
+      }
+    }
+    return result;
+  }
+
+  function triggerResults(results, isLast) {
+    jQuery.each(this.handlers, function(i, fn) {
+      fn.call(this, results, isLast)
+    })
+  }
+}
+

data/docs/panel/index.html

@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+	"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<head>
+	<title>search index</title>
+	<link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" charset="utf-8" />
+	<link rel="stylesheet" href="../css/panel.css" type="text/css" media="screen" charset="utf-8" />
+	<script src="../js/search_index.js" type="text/javascript" charset="utf-8"></script>
+	<script src="../js/searcher.js" type="text/javascript" charset="utf-8"></script>
+	<script src="tree.js" type="text/javascript" charset="utf-8"></script>
+	<script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
+	<script src="../js/searchdoc.js" type="text/javascript" charset="utf-8"></script>
+	<script type="text/javascript" charset="utf-8">
+    function placeholder() {
+        if ($('<input type="text">')[0].placeholder !== undefined) return;
+
+        $('#search-label').click(function() {
+            $('#search').focus();
+            $('#search-label').hide();
+        });
+
+        $('#search').focus(function() {
+            $('#search-label').hide();
+        });
+        $('#search').blur(function() {
+            this.value == '' && $('#search-label').show()
+        });
+
+        $('#search')[0].value == '' && $('#search-label').show();
+    }
+    $(function() {
+        placeholder();
+        $('#links').hide();
+        var panel = new Searchdoc.Panel($('#panel'), search_data, tree, window.parent.frames[1]);
+        $('#search').focus();
+
+        var s = window.parent.location.search.match(/\?q=([^&]+)/);
+        if (s) {
+            s = decodeURIComponent(s[1]).replace(/\+/g, ' ');
+            if (s.length > 0)
+            {
+                $('#search').val(s);
+                panel.search(s, true);
+            }
+        }
+    })
+	</script>
+</head>
+<body>
+    <div class="panel panel_tree" id="panel">
+        <div class="header">
+            <div>
+                <label for="search" id="search-label" style="display: none">Search</label>
+                <table>
+                <tr><td>
+                    <input type="Search" placeholder="Search" autosave="searchdoc" results="10" id="search" autocomplete="off"/>
+                </td></tr>
+            </table></div>
+        </div>
+        <div class="tree">
+            <ul>
+            </ul>
+        </div>
+        <div class="result">
+            <ul>
+            </ul>
+        </div>
+    </div>
+    <a href="links.html" id="links">index</a>
+</body>
+</html>

data/docs/panel/links.html

@@ -0,0 +1,12 @@
+<html>
+    <head>File index</head>
+    <body>
+    
+      <a href="../files/README_rdoc.html">README.rdoc</a>
+    
+      <a href="../files/lib/dm-is-published_rb.html">lib/dm-is-published.rb</a>
+    
+      <a href="../files/lib/is/published_rb.html">lib/is/published.rb</a>
+    
+    </body>
+</html>

data/docs/panel/tree.js

@@ -0,0 +1 @@
+var tree = [["","","files",[["README.rdoc","files/README_rdoc.html","",[]],["","","lib",[["dm-is-published.rb","files/lib/dm-is-published_rb.html","",[]],["","","is",[["published.rb","files/lib/is/published_rb.html","",[]]]]]]]],["DataMapper","classes/DataMapper.html","",[["Is","classes/DataMapper/Is.html","",[["Published","classes/DataMapper/Is/Published.html","",[["ClassMethods","classes/DataMapper/Is/Published/ClassMethods.html","",[]],["InstanceMethods","classes/DataMapper/Is/Published/InstanceMethods.html","",[]],["ResourceInstanceMethods","classes/DataMapper/Is/Published/ResourceInstanceMethods.html","",[]]]]]]]]]

data/lib/dm-is-published.rb

@@ -1,13 +1,9 @@
-# Needed to import datamapper and other gems
-# require 'rubygems' # read [ http://gist.github.com/54177 ] to understand why this line is commented out
-require 'pathname'
-
 # Add all external dependencies for the plugin here
-require 'dm-core'
-require 'dm-validations'
+require 'data_mapper'
+require 'active_support/core_ext/object/blank' unless ''.respond_to?(:blank?)
 
 # Require plugin-files
-require Pathname(__FILE__).dirname.expand_path / 'dm-is-published' / 'is' / 'published.rb'
+require_relative './is/published'
 
 DataMapper::Model.append_extensions(DataMapper::Is::Published)
 DataMapper::Model.append_inclusions(DataMapper::Is::Published::ResourceInstanceMethods)

data/lib/{dm-is-published/is → is}/published.rb

@@ -10,13 +10,13 @@ module DataMapper
     # 
     # 
     # == Installation
-    # 
-    #   #  Add GitHub to your RubyGems sources 
-    #   $  gem sources -a http://gems.github.com
-    # 
-    #   $  (sudo)? gem install kematzy-dm-is-published
-    # 
-    # <b>NB! Depends upon the whole DataMapper suite being installed, and has ONLY been tested with DM 0.10.0 (next branch).</b>
+    #
+    #   $  gem install dm-is-published
+    #
+    #
+    # Or add the gem to your Gemfile, and then run <tt>bundle install</tt>.
+    #
+    #   gem 'dm-is-published', 'CURRENT_VERSION_NUMBER'
     # 
     # 
     # == Getting Started
@@ -27,7 +27,7 @@ module DataMapper
     # 
     # Require +dm-is-published+ in your app.
     # 
-    #   require 'dm-core'         # must be required first
+    #   require 'data_mapper'         # must be required first
     #   require 'dm-is-published'
     # 
     # Lets say we have an Article class, and each Article can have a current state, 
@@ -103,7 +103,7 @@ module DataMapper
     # 
     # == Credits
     # 
-    # Copyright (c) 2008-05-07 [Kematzy at gmail]
+    # Copyright (c) 2008 - 2013 [Kematzy at gmail]
     # 
     # Loosely based on the ActsAsPublishable plugin by [http://fr.ivolo.us/posts/acts-as-publishable]
     # 
@@ -111,7 +111,8 @@ module DataMapper
     # 
     # Released under the MIT license.
     
-    module Published
+    module Published 
+      VERSION   = IO.read("#{File.dirname(__FILE__)}/../../VERSION").chomp
       
       ##
       # method that adds a basic published status attribute to your model
@@ -182,6 +183,21 @@ module DataMapper
       module ClassMethods
         attr_reader :publish_states, :publish_states_for_validation
         
+        ##
+        # Returns a JSON representation of the publish states, where each state 
+        # is represented as a lowercase key and an uppercase value.
+        #  
+        # ==== Examples
+        # 
+        #   Model.publish_states_as_json  
+        #     
+        #     => { 'live': 'LIVE','draft': 'DRAFT','hidden': 'HIDDEN' }
+        # 
+        # @api public
+        def publish_states_as_json
+          %Q[{ #{self.publish_states_for_validation.collect{ |state| "'#{state.to_s.downcase}': '#{state.to_s.upcase}'" }.join(',')} }]
+        end
+        
         ##
         # Overriding the normal #all method to add some extra sugar.
         #  

data/spec/{integration/published_spec.rb → dm-is-published_spec.rb}

@@ -1,10 +1,9 @@
-require 'pathname'
-require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+require_relative './spec_helper'
 
 if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
   describe 'DataMapper::Is::Published' do
     
-    class DefaultsArticle
+    class DefaultsArticle 
       include DataMapper::Resource
       property :id,     Serial
       property :title,   String
@@ -12,7 +11,7 @@ if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
       is :published
     end 
     
-    class Article
+    class Article 
       include DataMapper::Resource
       property :id,     Serial
       property :title,   String
@@ -20,7 +19,7 @@ if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
       is :published, :live, :draft, :prepared
     end 
     
-    class Image
+    class Image 
       include DataMapper::Resource
       property :id,     Serial
       property :title,   String
@@ -46,6 +45,13 @@ if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
       
     end
     
+    describe "VERSION" do 
+      
+      it "should have a VERSION constant" do 
+        DataMapper::Is::Published::VERSION.should match(/\d\.\d+\.\d+/)
+      end
+      
+    end #/ VERSION
     
     describe "Property :publish_status" do 
       
@@ -103,23 +109,23 @@ if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
           Image.publish_states.should == [:yes, :no]
         end
         
-        class ArticleWithDeclarationAsArray
+        class ArticleWithDeclarationAsArray 
           include DataMapper::Resource
           property :id,     Serial
           is :published, [:a, :b, :c]
         end 
         
-        it "should handle the states declared within [ Array ] brackets" do
+        it "should handle the states declared within [ Array ] brackets" do 
           ArticleWithDeclarationAsArray.publish_states.should == [:a, :b, :c]
         end
         
-        class ArticleWithDeclarationAsArrayOfStrings
+        class ArticleWithDeclarationAsArrayOfStrings 
           include DataMapper::Resource
           property :id,     Serial
           is :published, %w(a b c)
         end 
         
-        it "should handle the states declared as %w(a b c) " do
+        it "should handle the states declared as %w(a b c) " do 
           ArticleWithDeclarationAsArrayOfStrings.publish_states.should == [:a, :b, :c]
         end
         
@@ -135,6 +141,36 @@ if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
         
       end #/ #publish_states
       
+      describe "#publish_states_as_json" do 
+        
+        it "should return the states as an array of Symbols" do 
+          DefaultsArticle.publish_states_as_json.should == "{ 'live': 'LIVE','draft': 'DRAFT','hidden': 'HIDDEN' }"
+          Article.publish_states_as_json.should == "{ 'live': 'LIVE','draft': 'DRAFT','prepared': 'PREPARED' }"
+          Image.publish_states_as_json.should == "{ 'yes': 'YES','no': 'NO' }"
+        end
+        
+        class ArticleWithDeclarationAsArray 
+          include DataMapper::Resource
+          property :id,     Serial
+          is :published, [:a, :b, :c]
+        end 
+        
+        it "should handle the states declared within [ Array ] brackets" do 
+          ArticleWithDeclarationAsArray.publish_states_as_json.should == "{ 'a': 'A','b': 'B','c': 'C' }"
+        end
+        
+        class ArticleWithDeclarationAsArrayOfStrings 
+          include DataMapper::Resource
+          property :id,     Serial
+          is :published, %w(a b c)
+        end 
+        
+        it "should handle the states declared as %w(a b c) " do 
+          ArticleWithDeclarationAsArrayOfStrings.publish_states_as_json.should == "{ 'a': 'A','b': 'B','c': 'C' }"
+        end
+        
+      end #/ #publish_states
+      
       describe "#all" do 
         
         before(:each) do 
@@ -143,7 +179,7 @@ if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
           end
         end
         
-        it "should work as expected with Model.all" do
+        it "should work as expected with Model.all" do 
           Article.all.size.should == 8
         end
         
@@ -309,4 +345,5 @@ if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
     end #/ Validations
     
   end
-end
+  
+end #/ if