dm-is-published 0.0.6 → 1.2.0

data/docs/css/panel.css

@@ -0,0 +1,384 @@
+/* Panel (begin) */
+    .panel
+    {
+        position: absolute;
+        width: 100%;
+        height: 100%;
+        top: 0;
+        left: 0;
+        background: #FFF;
+        z-index: 2;
+        font-family: "Helvetica Neue", "Arial", sans-serif;
+        //zoom: 1;
+    }
+    
+    .panel_tree .results, 
+    .panel_results .tree 
+    {
+        display: none;
+    }
+    
+    /* Header with search box (begin) */
+        .panel .header
+        {
+            width: 100%;
+            height: 29px;
+            border-bottom: 1px solid #666;
+            position: relative;
+            left: 0; top: 0;
+            background: #e8e8e8;
+        }
+
+        .panel .header div
+        {
+            margin: 0 7px;
+        }
+        .panel .header table
+        {
+            height: 29px;
+            width: 100%;
+        }
+
+        .panel .header table td
+        {
+            vertical-align: middle;
+            text-align: middle;
+        }
+
+        .panel .header label
+        {
+            position: absolute;
+            font-size: 12px;
+            line-height: 29px;
+            margin-left: 3px;
+            color: #999;
+            cursor: text;
+        }
+
+        .panel .header table input
+        {
+            width: 100%;
+            box-sizing: border-box;
+            -moz-box-sizing: border-box;
+            -webkit-box-sizing: border-box;
+            display: inline-block;
+            -webkit-appearance: searchfield;
+            height: 22px;
+            //height: auto;
+        }
+        
+    /* Header with search box (end) */
+    
+        
+    /* Results (begin) */
+        .panel .result
+        {
+            position: absolute;
+            top: 30px;
+            bottom: 0;
+            left: 0;
+            width: 100%;
+            //height: expression((this.parentNode.offsetHeight - 31));
+            overflow-y: scroll;
+            overflow-x: hidden;
+            -overflow-y: hidden;
+            background: #EDF3FE url(../i/results_bg.png);
+            z-index: 2;
+            //zoom:1;
+        }
+
+        .panel .result ul
+        {
+            font-size: 0.8em;
+            width: 100%;
+            background: #EDF3FE url(../i/results_bg.png);
+            //zoom:1;
+        }
+
+        .panel .result ul li
+        {
+            height: 46px;
+            -height: 50px;
+            //display: inline;
+            //width: 100%;
+            //zoom: 1;
+            overflow: hidden;
+            padding: 4px 10px 0 10px;
+            cursor: pointer;
+        }
+
+        .panel .result ul li h1
+        {
+            font-size: 13px;
+            font-weight: normal;
+            color: #333;
+            margin-bottom: 2px;
+            white-space: nowrap;
+        }
+
+        .panel .result ul li p
+        {
+            font-size: 11px;
+            color: #333;
+            margin-bottom: 2px;
+            white-space: nowrap;
+        }
+
+        .panel .result ul li h1 i,
+        .panel .result ul li p.snippet
+        {
+            color: #999;
+        }
+
+        .panel .result ul li b
+        {
+            color: #000;
+        }
+
+        .panel .result ul li.current
+        {
+            background: #3875D7;
+        }
+
+        .panel .result ul li.current h1,
+        .panel .result ul li.current p
+        {
+            color: #DDD;
+        }
+
+        .panel .result ul li.current h1 i,
+        .panel .result ul li.current p.snippet
+        {
+            color: #AAA;
+        }
+
+        .panel .result ul li.current b
+        {
+            color: #FFF;
+        }
+
+
+        .panel .result ul li:hover,
+        .panel .result ul li.selected
+        {
+            background: #d0d0d0;
+        }
+
+        .panel .result ul li.current:hover
+        {
+            background: #2965C0;
+        }      
+        
+        .panel .result ul li .badge
+        {
+            margin-right: 0.4em;
+            margin-left: -0.2em;
+            padding: 0 0.2em;
+            color: #000;
+            border-radius: 3px;
+        }
+        
+        .panel .result ul li .badge_1
+        {
+            background: #ACDBF4;
+        }
+        
+        .panel .result ul li.current .badge_1
+        {
+            background: #97BFD7;
+        }
+        
+        .panel .result ul li .badge_2
+        {
+            background: #ACF3C3;
+        }
+        
+        .panel .result ul li.current .badge_2
+        {
+            background: #98D7AC;
+        }
+        
+        .panel .result ul li .badge_3
+        {
+            background: #E0F3AC;
+        }
+        
+        .panel .result ul li.current .badge_3
+        {
+            background: #C4D798;
+        }
+        
+        .panel .result ul li .badge_4
+        {
+            background: #D7CA98;
+        }
+        
+        .panel .result ul li.current .badge_4
+        {
+            background: #A6B0AC;
+        }
+        
+        .panel .result ul li .badge_5
+        {
+            background: #F3C8AC;
+        }
+        
+        .panel .result ul li.current .badge_5
+        {
+            background: #D7B198;
+        }
+        
+        .panel .result ul li .badge_6
+        {
+            background: #F3ACC3;
+        }
+        
+        .panel .result ul li.current .badge_6
+        {
+            background: #D798AB;
+        }
+        
+    /* Results (end) */
+    
+    /* Tree (begin) */ /**/
+        .panel .tree 
+        {
+            position: absolute;
+            top: 30px;
+            bottom: 0;
+            left: 0;
+            width: 100%;
+            //zoom: 1;
+            //height: expression((this.parentNode.offsetHeight - 31));
+            overflow-y: scroll;
+            overflow-x: hidden;
+            -overflow-y: hidden;
+            background: #EDF3FE url(../i/tree_bg.png);
+            z-index: 30;
+        }
+        
+        .panel .tree ul
+        {
+            background: #EDF3FE url(../i/tree_bg.png);
+        }          
+        
+        .panel .tree li
+        {
+            cursor: pointer;
+            overflow: hidden;
+            //height: 23px;
+            //display: inline;
+            //zoom: 1;
+            //width: 100%;
+        }
+        
+        
+        .panel .tree li .content
+        {
+            padding-left: 18px;
+            padding-top: 5px;
+            height: 18px;
+            overflow: hidden;
+            position: relative;
+        }
+        
+        .panel .tree li .icon
+        {
+            width: 10px;
+            height: 9px;
+            background: url(../i/arrows.png);
+            background-position: 0 -9px;
+            position: absolute;
+            left: 1px;
+            top: 8px;
+            cursor: default;
+        }
+        
+        .panel .tree li.closed .icon
+        {
+            background-position: 0 0;
+        }
+        
+        .panel .tree ul li h1
+        {
+            font-size: 13px;
+            font-weight: normal;
+            color: #000;
+            margin-bottom: 2px;
+            white-space: nowrap;
+        }
+
+        .panel .tree ul li p
+        {
+            font-size: 11px;
+            color: #666;
+            margin-bottom: 2px;
+            white-space: nowrap;
+        }
+        
+        .panel .tree ul li h1 i
+        {
+            color: #999;
+            font-style: normal;
+        }
+        
+        .panel .tree ul li.empty
+        {
+            cursor: text;
+        }   
+        
+        .panel .tree ul li.empty h1,
+        .panel .tree ul li.empty p
+        {
+            color: #666;
+            font-style: italic;
+        }
+        
+        .panel .tree ul li.current
+        {
+            background: #3875D7;
+        }
+        
+        .panel .tree ul li.current .icon
+        {
+            background-position: -10px -9px;
+        }
+        
+        .panel .tree ul li.current.closed .icon
+        {
+            background-position: -10px 0;
+        }
+
+        .panel .tree ul li.current h1
+        {
+            color: #FFF;
+        }
+
+        .panel .tree ul li.current p
+        {
+            color: #CCC;
+        }
+
+        .panel .tree ul li.current.empty h1,
+        .panel .tree ul li.current.empty p
+        {
+            color: #999;
+        }
+        
+        .panel .tree ul li:hover
+        {
+            background: #d0d0d0;
+        }
+
+        .panel .tree ul li.current:hover
+        {
+            background: #2965C0;
+        }
+        
+        .panel .tree .stopper
+        {
+            display: none;
+        }
+    /* Tree (end) */ /**/
+    
+/* Panel (end) */

data/docs/css/reset.css

@@ -0,0 +1,48 @@
+/* http://meyerweb.com/eric/tools/css/reset/ */
+/* v1.0 | 20080212 */
+
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, font, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td {
+	margin: 0;
+	padding: 0;
+	border: 0;
+	outline: 0;
+	font-size: 100%;
+	vertical-align: baseline;
+	background: transparent;
+}
+body {
+	line-height: 1;
+}
+ol, ul {
+	list-style: none;
+}
+blockquote, q {
+	quotes: none;
+}
+blockquote:before, blockquote:after,
+q:before, q:after {
+	content: '';
+	content: none;
+}
+
+/* remember to highlight inserts somehow! */
+ins {
+	text-decoration: none;
+}
+del {
+	text-decoration: line-through;
+}
+
+/* tables still need 'cellspacing="0"' in the markup */
+table {
+	border-collapse: collapse;
+	border-spacing: 0;
+}

data/docs/files/README_rdoc.html

@@ -0,0 +1,226 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+    <title>README.rdoc</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" />
+<link rel="stylesheet" href="../css/main.css" type="text/css" media="screen" />
+<link rel="stylesheet" href="../css/github.css" type="text/css" media="screen" />
+<script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
+<script src="../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
+<script src="../js/main.js" type="text/javascript" charset="utf-8"></script>
+<script src="../js/highlight.pack.js" type="text/javascript" charset="utf-8"></script>
+
+</head>
+
+<body>     
+    <div class="banner">
+        
+        <h1>
+            README.rdoc
+        </h1>
+        <ul class="files">
+            <li>README.rdoc</li>
+            <li>Last modified: 2013-03-11 01:06:17 +0800</li>
+        </ul>
+    </div>
+
+    <div id="bodyContent">
+        <div id="content">
+  
+    <div class="description">
+      
+<h1 id="label-dm-is-published">dm-is-published</h1>
+
+<p>This plugin makes it very easy to add different states to your models, like
+‘draft’ vs ‘live’.  By default it also adds validations of the field value.</p>
+
+<p>Originally inspired by the Rails plugin <code>acts_as_publishable</code> by
+<strong>fr.ivolo.us</strong>.</p>
+
+<h2 id="label-Installation">Installation</h2>
+
+<pre>$  gem install dm-is-published</pre>
+
+<p>Or add the gem to your Gemfile, and then run <code>bundle install</code>.</p>
+
+<pre>gem 'dm-is-published', 'CURRENT_VERSION_NUMBER'</pre>
+
+<h3 id="label-Dependencies">Dependencies</h3>
+
+<p>The plugin depends upon the following:</p>
+<ul><li>
+<p>dm-mysql-adapter  OR  dm-sqlite3-adapter ( &gt;= 1.2.0)</p>
+</li><li>
+<p>data_mapper ( &gt;= 1.2.0)</p>
+</li><li>
+<p>activesupport (&gt;= 3.2.7)  -  method =&gt; Object#blank?</p>
+</li></ul>
+
+<h2 id="label-Getting+Started+">Getting Started </h2>
+
+<p>First of all, for a better understanding of this gem, make sure you study 
+the ‘<code>dm-is-published/spec/dm-is-published_spec.rb</code>’ file.</p>
+<hr style="height: 2px">
+
+<p>Require <code>dm-is-published</code> in your app.</p>
+
+<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'data_mapper'</span>         <span class="ruby-comment"># must be required first</span>
+<span class="ruby-identifier">require</span> <span class="ruby-string">'dm-is-published'</span>
+</pre>
+
+<p>Lets say we have an Article class, and each Article can have a current
+state,  ie: whether it’s Live, Draft or an Obituary awaiting the death of
+someone famous (real or rumored)</p>
+
+<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">Article</span>
+  <span class="ruby-identifier">include</span> <span class="ruby-constant">DataMapper</span><span class="ruby-operator">::</span><span class="ruby-constant">Resource</span>
+  <span class="ruby-identifier">property</span> :<span class="ruby-identifier">id</span>,     <span class="ruby-constant">Serial</span>
+  <span class="ruby-identifier">property</span> :<span class="ruby-identifier">title</span>,   <span class="ruby-constant">String</span>
+  <span class="ruby-operator">...</span><span class="ruby-operator">&lt;</span><span class="ruby-identifier">snip</span><span class="ruby-operator">&gt;</span>
+
+  <span class="ruby-identifier">is</span> :<span class="ruby-identifier">published</span>
+
+<span class="ruby-keyword">end</span>
+</pre>
+
+<p>Once you have your Article model we can create our Articles just as normal</p>
+
+<pre class="ruby"><span class="ruby-constant">Article</span>.<span class="ruby-identifier">create</span>(:<span class="ruby-identifier">title</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'Example 1'</span>)
+</pre>
+
+<p>The instance of <code>Article.get(1)</code> now has the following things
+for free:</p>
+<ul><li>
+<p>a <code>:publish_status</code> attribute with the value
+<code>'live'</code>. Default choices are <code>[ :live, :draft, :hidden
+]</code>.</p>
+</li><li>
+<p><code>:is_live?, :is_draft? or :is_hidden?</code> methods that returns
+true/false based upon the state.</p>
+</li><li>
+<p><code>:save_as_live</code>, <code>:save_as_draft</code> or
+<code>:save_as_hidden</code> converts the instance to the state and saves
+it.</p>
+</li><li>
+<p><code>:publishable?</code> method that returns true for models where
+<code>is :published </code> has been declared, but <strong>false</strong>
+for those where it has not been declared.</p>
+</li></ul>
+
+<p>The Article class also gets a bit of new functionality:</p>
+
+<pre class="ruby"><span class="ruby-constant">Article</span>.<span class="ruby-identifier">all</span>(:<span class="ruby-identifier">draft</span>)  =<span class="ruby-operator">&gt;</span>  <span class="ruby-identifier">finds</span> <span class="ruby-identifier">all</span> <span class="ruby-constant">Articles</span> <span class="ruby-identifier">with</span> :<span class="ruby-identifier">publish_status</span> = :<span class="ruby-identifier">draft</span>
+
+<span class="ruby-constant">Article</span>.<span class="ruby-identifier">all</span>(:<span class="ruby-identifier">draft</span>, :<span class="ruby-identifier">author</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@author_joe</span> )  =<span class="ruby-operator">&gt;</span>  <span class="ruby-identifier">finds</span> <span class="ruby-identifier">all</span> <span class="ruby-constant">Articles</span> <span class="ruby-identifier">with</span> :<span class="ruby-identifier">publish_status</span> = :<span class="ruby-identifier">draft</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">author</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Joe</span>
+</pre>
+
+<p>Todo Need to write more documentation here..</p>
+
+<h2 id="label-Usage+Scenarios">Usage Scenarios</h2>
+
+<p>In a Blog/Publishing scenario you could use it like this:</p>
+
+<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">Article</span> 
+  <span class="ruby-operator">...</span><span class="ruby-operator">&lt;</span><span class="ruby-identifier">snip</span><span class="ruby-operator">&gt;</span><span class="ruby-operator">...</span>
+
+  <span class="ruby-identifier">is</span> :<span class="ruby-identifier">published</span> <span class="ruby-operator">:</span><span class="ruby-identifier">live</span>, :<span class="ruby-identifier">draft</span>, :<span class="ruby-identifier">hidden</span>
+
+<span class="ruby-keyword">end</span>
+</pre>
+
+<p>Whereas in another scenario - like in a MenuItem model for a Restaurant -
+you could use it like this:</p>
+
+<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">MenuItem</span>
+  <span class="ruby-operator">...</span><span class="ruby-operator">&lt;</span><span class="ruby-identifier">snip</span><span class="ruby-operator">&gt;</span><span class="ruby-operator">...</span>
+
+  <span class="ruby-identifier">is</span> :<span class="ruby-identifier">published</span>  <span class="ruby-operator">:</span><span class="ruby-identifier">on</span>, :<span class="ruby-identifier">off</span>  <span class="ruby-comment"># the item is either on the menu or not</span>
+
+<span class="ruby-keyword">end</span>
+</pre>
+
+<h2 id="label-RTFM+">RTFM </h2>
+
+<p>For a better understanding of this gem/plugin, make sure you study the
+‘<code>dm-is-select/spec/dm-is-select_spec.rb</code>’ file.</p>
+
+<h2 id="label-Errors+%2F+Bugs">Errors / Bugs</h2>
+
+<p>If something is not behaving intuitively, it is a bug, and should be
+reported. Report it here: <a
+href="http://github.com/kematzy/dm-is-published/issues">github.com/kematzy/dm-is-published/issues</a></p>
+
+<h2 id="label-Contributing+to+dm-is-published">Contributing to dm-is-published</h2>
+<ul><li>
+<p>Check out the latest master to make sure the feature hasn’t been
+implemented or the bug hasn’t been fixed yet.</p>
+</li><li>
+<p>Check out the issue tracker to make sure someone already hasn’t requested
+it and/or contributed it.</p>
+</li><li>
+<p>Fork the project.</p>
+</li><li>
+<p>Start a feature/bugfix branch.</p>
+</li><li>
+<p>Commit and push until you are happy with your contribution.</p>
+</li><li>
+<p>Make sure to add tests for it. This is important so I don’t break it in a
+future version unintentionally.</p>
+</li><li>
+<p>Please try not to mess with the Rakefile, version, or history. If you want
+to have your own version, or is otherwise necessary, that is fine, but
+please isolate to its own commit so I can cherry-pick around it.</p>
+</li></ul>
+
+<h2 id="label-Copyright">Copyright</h2>
+
+<p>Copyright © 2009 - 2013 Kematzy.</p>
+
+<p>Loosely based on the ActsAsPublishable plugin by [<a
+href="http://fr.ivolo.us/posts/acts-as-publishable">fr.ivolo.us/posts/acts-as-publishable</a>]</p>
+
+<h2 id="label-Licence">Licence</h2>
+
+<p>Released under the MIT license.</p>
+
+    </div>
+  
+
+
+  
+
+
+  
+  
+
+
+  
+
+
+  
+
+  
+
+
+
+  
+
+    
+
+    
+
+    
+
+
+    
+
+
+    <!-- Methods -->
+              </div>
+
+    </div>
+  </body>
+</html>