clipster 0.3.0 → 0.4.0

data/app/assets/stylesheets/clipster/clip.css

@@ -1,22 +1,32 @@
-/*
-  Place all the styles related to the matching controller here.
-  They will automatically be included in application.css.
-*/
-
-.bordered {
-  border: 1px solid #dddddd;
-  border-collapse: separate;
-  *border-collapse: collapse;
-  /*border-left: 0;*/
-  -webkit-border-radius: 4px;
-     -moz-border-radius: 4px;
-          border-radius: 4px;
-}
-
-.bordered div {
-    margin: 5px;
-}
-
-.title {
-    border-bottom: 1px solid #ddd;
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+.bordered {
+  border: 1px solid #dddddd;
+  border-collapse: separate;
+  *border-collapse: collapse;
+  /*border-left: 0;*/
+  -webkit-border-radius: 4px;
+     -moz-border-radius: 4px;
+          border-radius: 4px;
+}
+
+.bordered div {
+    margin: 5px;
+}
+
+.title {
+    border-bottom: 1px solid #ddd;
+}
+
+.help-tip label{
+    display: inline;
+}
+
+.image-feed {
+    width: 14px;
+    height: 14px;
+    background:url("../Clipster/rss_logo_small.png");
 }

data/app/assets/stylesheets/clipster/clips.css

@@ -1,4 +1,4 @@
-/*
-  Place all the styles related to the matching controller here.
-  They will automatically be included in application.css.
-*/
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/clipster/users.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/clipster/application_controller.rb

@@ -1,7 +1,14 @@
-module Clipster
-  class ApplicationController < ActionController::Base
-    def index
-      render :text => "Welcome 2 Clipster"
-    end 
-  end
-end
+module Clipster
+  class ApplicationController < ActionController::Base
+    before_filter :set_current_user
+
+    private
+      def set_current_user
+        begin
+          Clip.current_user = current_user if Clipster.config.associates_clip_with_user
+        rescue Exception => e
+          raise "If User assocations have been enabled for Clipster, your application should have a current_user helper defined"
+        end
+      end
+  end
+end

data/app/controllers/clipster/clips_controller.rb

@@ -1,80 +1,86 @@
-require_dependency "clipster/application_controller"
-
-module Clipster
-  class ClipsController < ApplicationController
-    def index
-      create
-      render 'create'
-    end
-
-    def list
-      # get all clips, with the newest clip first
-      if params[:lang].nil?
-        @clips = Clip.public.order('created_at DESC').page(params[:page])
-      else
-        @clips = Clip.language_for_public(params[:lang]).order('created_at DESC').page(params[:page])
-      end
-      
-      @languages = Clip.public.select("language, count(*) as count").group(:language)
-    end
-    
-    def create
-      @clip = Clip.new(params[:clip])
-      
-      #only do validation if something was actually posted.
-      if !params[:clip].nil? && @clip.valid?
-        @clip.save
-        redirect_to @clip
-        return #early return so we don't have else statement
-      end
-      
-      # Get all languages we have syntax for and remove debugging languages.
-      @languages = get_languages
-    end
-    
-    def show
-      @clip = Clip.where("url_hash = :id and (expires is null OR expires > :now)",{
-          :id => params[:id],
-          :now => DateTime.now
-      }).first
-      
-      if @clip.nil?
-        # Most likely the clip is expired, take advantage of this time to
-        # clean up all expired clips, then display error page
-        Clip.delete_expired_clips
-        render :expired
-        return
-      end
-      
-      cr_scanner = CodeRay.scan(@clip.clip, @clip.language)
-
-      # Only show line numbers if its greater than 1
-      @clip_div = cr_scanner.div
-      @clip_div = cr_scanner.div(:line_numbers => :table) unless cr_scanner.loc <= 1
-    end
-
-    def search
-      @clips = Clip.search(params[:search_term])
-
-      p '\n\n\n\n'
-      p @clips
-
-      @languages = Clip.select("language, count(*) as count").group(:language)
-
-      render 'list' unless @clips.nil?  
-    end
-
-    def about
-    end
-    
-    private
-
-    def get_languages
-      languages = CodeRay::Scanners.all_plugins
-      languages.delete(CodeRay::Scanners::Raydebug)
-      languages.delete(CodeRay::Scanners::Debug)
-
-      languages
-    end
-  end
-end
+require_dependency "clipster/application_controller"
+
+module Clipster
+  class ClipsController < ApplicationController
+    def index
+      create
+      render 'create'
+    end
+
+    def list
+      # get all clips, with the newest clip first
+      if params[:lang].nil?
+        @clips = Clip.public.order('created_at DESC').page(params[:page])
+      else
+        @clips = Clip.language_for_public(params[:lang]).order('created_at DESC').page(params[:page])
+      end
+
+      @languages = Clip.public.select("language, count(*) as count").group(:language)
+      @updated_at = @clips.first.updated_at unless @clips.empty?
+
+      respond_to do |format|
+        format.html
+        format.atom
+      end
+    end
+
+    # TODO: refactor to do proper RESTful controller
+    def new
+      create
+      render 'create'
+    end
+
+    def create
+      @clip = Clip.new(params[:clip])
+
+      #only do validation if something was actually posted.
+      if !params[:clip].nil? && @clip.valid?
+        @clip.save
+        redirect_to @clip
+        return #early return so we don't have else statement
+      end
+
+      # Get all languages we have syntax for and remove debugging languages.
+      @languages = get_languages
+    end
+
+    def show
+      @clip = Clip.where("url_hash = :id and (expires is null OR expires > :now)",{
+          :id => params[:id],
+          :now => DateTime.now
+      }).first
+
+      if @clip.nil?
+        # Most likely the clip is expired, take advantage of this time to
+        # clean up all expired clips, then display error page
+        Clip.delete_expired_clips
+        render :expired
+        return
+      end
+    end
+
+    def search
+      @clips = Clip.search(params[:search_term]).page(params[:page])
+
+      p '\n\n\n\n'
+      p @clips
+
+      @languages = Clip.select("language, count(*) as count").group(:language)
+
+      render 'list' unless @clips.nil?
+    end
+
+    def about
+    end
+
+    private
+
+    def get_languages
+      languages = CodeRay::Scanners.all_plugins
+      languages.delete(CodeRay::Scanners::Raydebug)
+      languages.delete(CodeRay::Scanners::Debug)
+
+      languages
+    end
+  end
+end

data/app/controllers/clipster/users_controller.rb

@@ -0,0 +1,17 @@
+require_dependency "clipster/application_controller"
+
+module Clipster
+  class UsersController < ApplicationController
+    def index
+
+    end
+
+    def show
+      @user = Clipster.config.user_class.find(params[:id])
+
+      @clips = Clip.public.where(:user_id => @user.id).page(params[:page])
+
+      @languages = Clip.select("language, count(*) as count").group(:language)
+    end
+  end
+end

data/app/helpers/clipster/application_helper.rb

@@ -1,4 +1,19 @@
-module Clipster
-  module ApplicationHelper
-  end
-end
+module Clipster
+  module ApplicationHelper
+    def get_languages
+      languages = CodeRay::Scanners.all_plugins
+      languages.delete(CodeRay::Scanners::Raydebug)
+      languages.delete(CodeRay::Scanners::Debug)
+
+      languages
+    end
+
+    def get_language_counts
+      Clip.select("language, count(*) as count").group(:language)
+    end
+
+    def display_user_text(user)
+      user.send(Clipster.config.user_display_attribute)
+    end
+  end
+end

data/app/helpers/clipster/clip_helper.rb

@@ -1,4 +1,4 @@
-module Clipster
-  module ClipHelper
-  end
-end
+module Clipster
+  module ClipHelper
+  end
+end

data/app/helpers/clipster/clips_helper.rb

@@ -1,4 +1,4 @@
-module Clipster
-  module ClipsHelper
-  end
-end
+module Clipster
+  module ClipsHelper
+  end
+end

data/app/helpers/clipster/users_helper.rb

@@ -0,0 +1,4 @@
+module Clipster
+  module UsersHelper
+  end
+end

data/app/models/clipster/clip.rb

@@ -1,74 +1,99 @@
-module Clipster
-  class Clip < ActiveRecord::Base
-    include ActionView::Helpers::DateHelper
-    before_create :init_id
-    self.primary_key = :url_hash
-    attr_accessible :clip, :language, :title, :private, :expires, :lifespan
-    cattr_reader :lifespans
-    
-    # Define all supported lifespans and their time offset 
-    @@lifespans = {"Forever" => nil,
-                   "An Hour" => {:hours=>1},
-                   "A Week"  => {:days=>7},
-                   "A Day"   => {:days=>1},
-                   "A Month" => {:months=>1},
-                   "A Year"  => {:years=>1}}
-    
-    # TODO: build more powerful search term creation
-    scope :search, lambda {|term| 
-      where("(title LIKE :term or language LIKE :term or clip LIKE :term) and (expires is null OR expires > :now)",{
-          :term => term,
-          :now => DateTime.now
-      })
-    }
-    
-    # All clips that are public, language specific, and not expired
-    scope :language_for_public, lambda {|lang| 
-      where("private = :private AND
-             language = :lang AND
-             (expires is null OR expires > :now)",{
-          :private => false,
-          :lang => lang,
-          :now  => DateTime.now
-      })
-    }
-    
-    # All clips that are public, and not expired
-    scope :public, lambda {
-      where("private = :private AND
-             (expires is null OR expires > :now)",{
-          :private => false,
-          :now  => DateTime.now
-      })
-    }
-    
-    validates :clip, :length => {:minimum   => 3}
-    validates :title, :length => {:minimum   => 1}
-    
-    # Setter to convert user's choice of 'A Week', etc. to an actual DateTime
-    def lifespan=(lifespan)
-      unless @@lifespans[lifespan].nil?
-        self.expires = DateTime.now.advance(@@lifespans[lifespan])
-      end
-    end
-    
-    # Getter to convert an expire date to '1 Month', '1 Year', etc.
-    def lifespan
-      unless self.expires.nil?
-        time_ago_in_words(self.expires)
-      else
-        "the end of time"
-      end
-    end
-    
-    # Utility method called by either cron job or when an expired clip is accessed
-    def Clip.delete_expired_clips
-      Clip.destroy_all(["expires is not null AND expires <= ?", DateTime.now])
-    end
-    
-    private
-      def init_id
-        self.url_hash = Time.now.to_f.to_s.gsub('.','').to_i.to_s(36)
-      end
-  end
-end
+module Clipster
+  class Clip < ActiveRecord::Base
+    include ActionView::Helpers::DateHelper
+
+    self.primary_key = :url_hash
+
+    before_create :default_values
+
+    attr_accessible :clip, :language, :title, :private, :expires, :lifespan
+    cattr_reader :lifespans
+    cattr_accessor :current_user, :lifespan
+
+    belongs_to :user, :class_name => Clipster.config.user_class.to_s unless not Clipster.config.associates_clip_with_user
+
+    validates :clip, :length => {:minimum   => 3}
+    validates :title, :length => {:minimum   => 1}
+
+    # Define all supported lifespans and their time offset
+    @@lifespans = [["Forever", nil],
+                   ["An Hour", :hours=>1],
+                   ["A Week", :days=>7],
+                   ["A Day", :days=>1],
+                   ["A Month", :months=>1],
+                   ["A Year", :years=>1]]
+
+    # TODO: build more powerful search term creation
+    scope :search, lambda {|term|
+      where("(title LIKE :term or language LIKE :term or clip LIKE :term) and (expires is null OR expires > :now)",{
+          :term => term,
+          :now => DateTime.now
+      })
+    }
+
+    # All clips that are public, language specific, and not expired
+    scope :language_for_public, lambda {|lang|
+      where("private = :private AND
+             language = :lang AND
+             (expires is null OR expires > :now)",{
+          :private => false,
+          :lang => lang,
+          :now  => DateTime.now
+      })
+    }
+
+    # All clips that are public, and not expired
+    scope :public, lambda {
+      where("private = :private AND
+             (expires is null OR expires > :now)",{
+          :private => false,
+          :now  => DateTime.now
+      })
+    }
+
+    # Setter to convert user's choice of 'A Week', etc. to an actual DateTime
+    def lifespan=(lifespan)
+      @lifespan = lifespan
+      @@lifespans.each_with_index do |span, index|
+        if span[0] == lifespan
+          self.expires = DateTime.now.advance(@@lifespans[index][1])
+        end
+      end
+    end
+
+    def lifespan
+      @lifespan
+    end
+
+    # Getter to convert an expire date to '1 Month', '1 Year', etc.
+    def expires_in_words
+      unless self.expires.nil?
+        time_ago_in_words(self.expires).humanize
+      else
+        "The end of time"
+      end
+    end
+
+    # Utility method called by either cron job or when an expired clip is accessed
+    def Clip.delete_expired_clips
+      Clip.destroy_all(["expires is not null AND expires <= ?", DateTime.now])
+    end
+
+    # Creates the div for the clip
+    def div
+      cr_scanner = CodeRay.scan(self.clip, self.language)
+      # Only show line numbers if its greater than 1
+      if cr_scanner.loc <= 1
+        return cr_scanner.div
+      else
+        return cr_scanner.div(:line_numbers => :table)
+      end
+    end
+
+    private
+      def default_values
+        self.user_id = self.current_user unless not Clipster.config.associates_clip_with_user
+        self.url_hash = Time.now.to_f.to_s.gsub('.','').to_i.to_s(36)
+      end
+  end
+end

data/app/views/clipster/clips/about.html.erb

@@ -1,15 +1,15 @@
-<legend>About Clipster</legend>
-
-<div class="span10 offset1">
-  <p>Clipster is an Open Source Rails engine to add clipboard code sharing to your existing Ruby on Rails applications. Complete with syntax highlighting and expiring clips, its great for internal code sharing. Please visit us on <%= link_to("GitHub", "http://github.com/kwbock/clipster") %> for downloads and support.</p>
-</div>
-
-<div class="well span9 offset1">
-  <p>Copyright 2012 Kyle Bock, Daniel White</p>
-
-  <p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
-
-  <p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p>
-
-  <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
+<legend>About Clipster v.<%=Clipster::VERSION%></legend>
+
+<div class="span10 offset1">
+  <p>Clipster is an Open Source Rails engine to add clipboard code sharing to your existing Ruby on Rails applications. Complete with syntax highlighting and expiring clips, its great for internal code sharing. Please visit us on <%= link_to("GitHub", "http://github.com/kwbock/clipster") %> for downloads and support.</p>
+</div>
+
+<div class="well span9 offset1">
+  <p>Copyright 2012 Kyle Bock, Daniel White</p>
+
+  <p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
+
+  <p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p>
+
+  <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
 </div>

data/app/views/clipster/clips/create.html.erb

@@ -1,47 +1,57 @@
-<legend>New Clip</legend>
-
-<%= form_for(@clip, :url => { :action => "create" }) do |f| %>
-  <%= f.error_messages %>
-  
-  <!-- title -->
-  <div class="span5 offset1">
-    <div class="span4 no-left">
-      <%= f.label(:title) %>
-      <%= f.text_field(:title, :value => @clip.title, :required=>"required") %>
-    </div>
-    <!-- /title -->
-    
-    <!-- language -->
-    <div class="span4 no-left">
-      <%= f.label(:language) %>
-      <%= f.collection_select("language", @languages, :lang, :title, :selected => (@clip.language || "text")) %>
-    </div>
-    <!-- /language -->
-  </div>
-  <div class="span5 offset1 pull-right no-left">
-    <!-- lifespan -->
-    <div class="span4">
-      <%= f.label(:lifespan) %>
-      <%= f.select(:lifespan, @clip.lifespans) %>
-    </div>
-    <!-- /lifespan -->
-    
-    <!-- private -->
-    <div class="span4">
-      <%= f.label(:private) %>
-      <%= f.check_box(:private, :value => @clip.private) %>
-    </div>
-    <!-- /private -->
-  </div>
-  
-  <!-- clip -->
-  <div class="span10 offset1">
-    <%= f.label(:clip) %>
-    <%= f.text_area(:clip, :class=>"span10", :rows=>"15", :value => @clip.clip, :required=>"required") %>
-  </div>
-  <!-- /clip -->
-  
-  <div class="span2 pull-right">
-    <%= f.submit(:class=>"btn btn-primary") %>
-  </div>
+<legend>New Clip</legend>
+
+<%= form_for(@clip, :url => { :action => "create" }) do |f| %>
+  <%= f.error_messages %>
+  
+  <!-- 1st Row -->
+  <div class="span5 offset1">
+    <!-- title -->
+    <div class="span4 no-left">
+      <div class="help-tip">
+        <%= f.label(:title) %> <i class="icon-question-sign" data-title="Name your clip"></i></div>
+      <%= f.text_field(:title, :value => @clip.title, :required=>"required") %>
+    </div>
+    <!-- /title -->
+    
+    <!-- language -->
+    <div class="span4 no-left">
+      <div class="help-tip">
+        <%= f.label(:language) %> <i class="icon-question-sign" data-title="Choose a language for syntax highlighting"></i></div>
+      <%= f.collection_select("language", @languages, :lang, :title, :selected => (@clip.language || "text")) %>
+    </div>
+    <!-- /language -->
+  </div>
+  <!-- /1st Row -->
+  
+  <!-- 2nd Row -->
+  <div class="span5 offset1 pull-right no-left">
+    <!-- lifespan -->
+    <div class="span4">
+      <div class="help-tip">
+        <%= f.label(:lifespan) %> <i class="icon-question-sign" data-title="Choose how long the clip should remain available"></i></div>
+      <%= f.select(:lifespan, @clip.lifespans, :selected=>(@clip.lifespan || "Forever")) %>
+    </div>
+    <!-- /lifespan -->
+    
+    <!-- private -->
+    <div class="span4">
+      <div class="help-tip">
+        <%= f.label(:private) %> <i class="icon-question-sign" data-title="Only allow those with a link to access the clip"></i></div>
+      <%= f.check_box(:private, :value => @clip.private) %>
+    </div>
+    <!-- /private -->
+  </div>
+  <!-- /2nd Row -->
+  
+  <!-- clip -->
+  <div class="span10 offset1">
+    <div class="help-tip">
+      <%= f.label(:clip) %> <i class="icon-question-sign" data-title="The main content to be shared"></i></div>
+    <%= f.text_area(:clip, :class=>"span10", :rows=>"15", :value => @clip.clip, :required=>"required") %>
+  </div>
+  <!-- /clip -->
+  
+  <div class="span2 pull-right">
+    <%= f.submit(:class=>"btn btn-primary") %>
+  </div>
 <% end %>