dog_ears 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 709c098d8cff2b4bc02746ea114aeca43e94ec35
+  data.tar.gz: 01728ee8bdc68c526b421a11d0011a12dee9b72d
+SHA512:
+  metadata.gz: 0b4d0b5e1168aff07808acac3773a4ca4bfbe44e77212c6ec8ac47fdbd257872f121127e6f227adea64a17e3235ea4701b99afc4d0f9558e62fd264f5247d241
+  data.tar.gz: b16a5362c48123887315fec8e2c6b13c4f66932ae145cee8e54e2b62374d596366fc9e0a611bd47b8be6fa785ab6dacf49c5579f9d42e46345d56b83f4eb848e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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.

data/README.rdoc

@@ -0,0 +1,46 @@
+= DogEars
+
+Gem for generic in-app-bookmarks and bookmark-sharing between users. Slightly WIP.
+
+== Gemfile
+
+<pre>
+  gem 'dog_ears'
+</pre>
+
+
+== routes.rb
+
+Add <tt>dog_ears</tt> in the appropriate place
+
+== controller
+
+Add a BookmarksController at the appropriate place. This needs to inherit fro your apps controllers, such that <tt>current_user</tt> is available:
+
+<pre>
+  class Admin::...::BookmarksController < Admin::...::ApplicationController
+    include DogEars::Controller
+  end
+</pre>
+
+== views/layout
+
+In you layout, use <tt><%= dog_ears admin_..._bookmarks_path %></tt> to inject the required html-code
+
+== stylesheets/javascript
+
+<tt>//= require dog_ears/application</tt> as usual :)
+
+== Migrations
+
+<tt>rake dog_ears:install:migrations</tt>
+
+and then
+
+<tt>rake db:migrate</tt>
+
+== License
+
+This project rocks and uses MIT-LICENSE.
+
+Copyright (c) 2013 by Peter Horn, Provideal GmbH

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DogEars'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/dog_ears/application.js

@@ -0,0 +1,148 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+
+jQuery(function($){
+  function init_dog_ears(url) {
+    var dog_ears = $('#dog-ears')
+    var listbox    = dog_ears.find("#bookmark-list");
+    var form       = dog_ears.find('form#bookmark-form');
+    var shareform  = dog_ears.find('form#bookmark-transfer-form');
+    var path   = dog_ears.data('path');
+    var method = dog_ears.data('method');
+    var title  = dog_ears.data('title');
+    var id     = dog_ears.data('id');
+    var pinned = dog_ears.hasClass('pinned');
+
+    dog_ears.find('#bookmark-pin').click(function(e) {
+      e.stopPropagation();
+      if(!pinned) {
+        $('#dog-ears-bookmark-level').val(0);
+        $('#dog-ears-bookmark-name').val(document.title);
+        form.show();
+      } else {
+        $.ajax(url + "/" + id, {
+          type: 'delete',
+          success: new_component
+        })
+      }
+      return false;
+    });
+
+    dog_ears.find('.bookmark-title').click(function(e) {
+      e.stopPropagation();
+      $('#dog-ears-bookmark-level').val(0);
+      $('#dog-ears-bookmark-name').val(title);
+      form.show();
+      return false;
+    });
+
+
+    function new_component(data) {
+      dog_ears.replaceWith(data);
+      init_dog_ears(url);
+    }
+
+    dog_ears.find('span.level').click(function(e) {
+      e.stopPropagation();
+      var span = $(this);
+      $.ajax(url, {
+        type: 'get',
+        data: { level: span.data('level') },
+        success: show_bookmarks
+      });
+      listbox.css('background-color', span.css('background-color'));
+      listbox.css('color', span.css('color'));
+    });
+
+    function show_bookmarks(data) {
+      listbox.html();
+      var ul = $("<ul/>");
+      $.each(data, function(i,bm) {
+        var a = $("<a/>").attr('href', bm.path).html(bm.title);
+        ul.append($("<li/>").html(a));
+      });
+      listbox.html(ul);
+      listbox.show();
+    }
+
+    dog_ears.find('button[data-level]').click(function(){
+      dog_ears.find('button[type="submit"]').attr('class', $(this).attr('class')).removeClass('btn-mini');
+      dog_ears.find('#dog-ears-bookmark-level').val($(this).data('level'));
+    })
+
+    form.submit(function(event){
+      event.stopPropagation();
+      var level = $('#dog-ears-bookmark-level').val();
+      var name  = $('#dog-ears-bookmark-name').val();
+      $.ajax(url, {
+        data: {
+          path: path,
+          title: name,
+          level: level
+        },
+        type: 'post',
+        success: new_component
+      })
+      form.hide();
+      return false;
+    });
+
+    $('#dog-ears').click(function(event){
+      event.stopPropagation();
+    });
+
+    dog_ears.find('#bookmark-share').click(function(e) {
+      e.stopPropagation();
+      $.ajax(url + "/get_users", {
+        type: 'get',
+        success: show_share_form
+      });
+      return false;
+    });
+
+    function show_share_form(data) {
+      var select = $('select#dog-ears-new-user');
+      select.html();
+      $.each(data, function(id,name){
+        var option = $('<option>');
+        option.val(id);
+        option.html(name);
+        select.append(option);
+      });
+      shareform.show();
+    }
+
+    shareform.submit(function(){
+      var uid = $('select#dog-ears-new-user option:selected').val();
+      $.ajax(url + "/" + id + "/share", {
+        type: 'post',
+        data: { user_id: uid },
+        success: new_component
+      })
+      return false;
+    });
+
+  }
+
+  $('html').click(function() {
+    $('#bookmark-form').hide();
+    $('#bookmark-list').hide();
+    $('#bookmark-transfer-form').hide();
+  });
+
+  // $(document).on('click', '#dog_ears', function(event){
+  //   event.stopPropagation();
+  // });
+
+  init_dog_ears($("#dog-ears").data('url'));
+});

data/app/assets/stylesheets/dog_ears/application.css

@@ -0,0 +1,98 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ */
+
+div#dog-ears {
+  width: auto;
+  min-width: 20px;
+  height: 20px;
+  background-color: lightgray;
+  position: fixed;
+  right: 0px;
+  bottom: 0px;
+  z-index: 12000;
+  border: 1px solid gray;
+  padding: 5px;
+  line-height: 15px;
+
+  i#bookmark-pin:hover, span.level {
+    cursor: pointer;
+  }
+
+  .bookmark-title {
+    display: none;
+  }
+
+  &.pinned {
+    .bookmark-title {
+      display: inline-block;
+    }
+  }
+
+  #bookmark-list, #bookmark-form, #bookmark-transfer-form {
+    white-space: nowrap;
+    position: fixed;
+    bottom: 32px;
+    right: 0px;
+    max-width: 400px;
+    max-height: 400px;
+    z-index: 12001;
+    display: none;
+    background-color: lightgray;
+    border: 1px solid gray;
+    padding: 5px;
+    margin: 0;
+
+    a {
+      color: inherit;
+    }
+  }
+
+  #bookmark-list {
+    padding: 0px;
+    overflow: scroll;
+
+    ul {
+      padding: 0;
+      margin: 0;
+      list-style-type: none;
+
+      li {
+        padding: 5px;
+        border-bottom: 1px solid white;
+
+        &:last-child {
+          border-bottom: none;
+        }
+      }
+    }
+  }
+
+  #bookmark-form {
+    bottom: 0px;
+    padding: 10px;
+    width: 300px;
+    height: 70px;
+
+    input[type=text] {
+      width: 240px;
+    }
+  }
+
+  #bookmark-transfer-form {
+    bottom: 0px;
+    padding: 10px;
+
+    select {
+      margin-right: 10px;
+    }
+  }
+}

data/app/controllers/dog_ears/application_controller.rb

@@ -0,0 +1,4 @@
+module DogEars
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+module ApplicationHelper
+  include DogEarsHelper
+end

data/app/models/dog_ears/bookmark.rb

@@ -0,0 +1,23 @@
+module DogEars
+  class Bookmark < ActiveRecord::Base
+    # attr_accessible :title, :body
+    LEVELS = ['none', 'info', 'success', 'warning', 'important']
+    validates_inclusion_of :level, in: LEVELS
+
+    belongs_to :user
+
+    scope :for_user, ->(user) { where(user_id: user.id) }
+
+    def self.for_user_and_path(user,path)
+      for_user(user).where(path: path).first
+    end
+
+    def self.count_by_levels
+      cbl = group(:level).count
+      LEVELS.inject({}) do |a,e|
+        a[e] = cbl[e] if cbl[e] && cbl[e] > 0
+        a
+      end
+    end
+  end
+end

data/app/views/dog_ears/_dog_ears.html.erb

@@ -0,0 +1,38 @@
+<% path   ||= request.env['PATH_INFO'] %>
+<% method ||= request.method %>
+<%= content_tag :div, id: 'dog-ears', class: (b && 'pinned'),
+  data: {path: path, method: method,
+    url: bookmark_url, title: b.try(:title), id: b.try(:id) } do %>
+  <% if method == 'GET' && !b %>
+    <button class="btn btn-mini" type="button" id='bookmark-pin'><i class="icon-pushpin"></i></button>
+  <% end %>
+  <span class="bookmark-title label label-<%= b.try(:level) %>"><%= b.try(:title) %></span>
+  <% if b %>
+    <button class="btn btn-mini" type="button" id='bookmark-pin'><i class="icon-remove"></i></button>
+    <button class="btn btn-mini" type="button" id='bookmark-share'><i class="icon-share"></i></button>
+  <% end %>
+  <% DogEars::Bookmark.for_user(current_user).count_by_levels.each do |l,c| %>
+    <span class="badge badge-<%= l %> level" data-level="<%= l %>"><%= c %></span>
+  <% end %>
+  <div id="bookmark-list"></div>
+  <form class="form" id="bookmark-form">
+    <div class="input-append">
+      <input type="text" id="dog-ears-bookmark-name" />
+      <button class="btn" type="submit"><i class="icon-pushpin"></i></button>
+    </div>
+    <div style="display:block">
+      <input type="hidden" id="dog-ears-bookmark-level" value="0" />
+      <button data-level="0" class="btn btn-mini" type="button"><i class="icon-flag"></i></button>
+      <button data-level="1" class="btn btn-mini btn-primary" type="button"><i class="icon-flag"></i></button>
+      <button data-level="2" class="btn btn-mini btn-success" type="button"><i class="icon-flag"></i></button>
+      <button data-level="3" class="btn btn-mini btn-warning" type="button"><i class="icon-flag"></i></button>
+      <button data-level="4" class="btn btn-mini btn-danger" type="button"><i class="icon-flag"></i></button>
+    </div>
+  </form>
+  <form class="form" id="bookmark-transfer-form">
+    <div class="input-append">
+      <select id="dog-ears-new-user"></select>
+      <button class="btn" type="submit"><i class="icon-share"></i></button>
+    </div>
+  </form>
+<% end -%>

data/app/views/layouts/dog_ears/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>DogEars</title>
+  <%= stylesheet_link_tag    "dog_ears/application", :media => "all" %>
+  <%= javascript_include_tag "dog_ears/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+DogEars::Engine.routes.draw do
+end

data/db/migrate/20130828134045_create_dog_ears_bookmarks.rb

@@ -0,0 +1,12 @@
+class CreateDogEarsBookmarks < ActiveRecord::Migration
+  def change
+    create_table :dog_ears_bookmarks do |t|
+      t.references :user
+      t.text :path
+      t.text :title
+      t.text :comment
+      t.string :level
+      t.timestamps
+    end
+  end
+end

data/lib/dog_ears/controller.rb

@@ -0,0 +1,44 @@
+module DogEars
+  module Controller
+
+    def index
+      @bookmarks = DogEars::Bookmark.for_user(current_user).where(level: params[:level])
+      render json: @bookmarks.to_json
+    end
+
+    def create
+      path = params[:path]
+      title = params[:title]
+      level = Bookmark::LEVELS[params[:level].to_i]
+      title = nil if title == 'null'
+      user = current_user
+      b = DogEars.bookmark(user, path, title, level)
+      render partial: '/dog_ears/dog_ears',
+        locals: { bookmark_url: '', b: b, path: b.path, method: 'GET' }
+    end
+
+    def get_users
+      uu = User.where('id <> ?', current_user.id)
+      render json: uu.inject({}){|a,e| a[e.id] = e.name; a }.to_json
+    end
+
+    def destroy
+      @bookmark = DogEars::Bookmark.for_user(current_user).find(params[:id])
+      @bookmark.destroy
+      render partial: '/dog_ears/dog_ears',
+        locals: { bookmark_url: '', b: nil, path: @bookmark.path, method: 'GET' }
+    end
+
+    def share
+      @bookmark = DogEars::Bookmark.for_user(current_user).find(params[:id])
+      user = User.find(params[:user_id])
+      nb = @bookmark.dup
+      nb.title = "[#{current_user.name}] #{nb.title}"
+      nb.user_id = user.id
+      nb.save!
+      render partial: '/dog_ears/dog_ears',
+        locals: { bookmark_url: '', b: @bookmark, path: @bookmark.path, method: 'GET' }
+    end
+
+  end
+end

data/lib/dog_ears/engine.rb

@@ -0,0 +1,5 @@
+module DogEars
+  class Engine < ::Rails::Engine
+    isolate_namespace DogEars
+  end
+end

data/lib/dog_ears/rails/helper.rb

@@ -0,0 +1,9 @@
+module DogEarsHelper
+
+  def dog_ears(bookmark_url)
+    raise "give the path for dog_ears" unless bookmark_url.present?
+    b = DogEars::Bookmark.for_user_and_path(current_user, request.env['PATH_INFO'])
+    render partial: '/dog_ears/dog_ears', locals: { bookmark_url: bookmark_url, b: b }
+  end
+
+end

data/lib/dog_ears/rails/routes.rb

@@ -0,0 +1,30 @@
+require "active_support/core_ext/object/try"
+require "active_support/core_ext/hash/slice"
+
+module ActionDispatch::Routing
+  class Mapper
+
+    def dog_ears(options={})
+      options[:as]          ||= @scope[:as]     if @scope[:as].present?
+      options[:module]      ||= @scope[:module] if @scope[:module].present?
+      options[:path_prefix] ||= @scope[:path]   if @scope[:path].present?
+      options[:path_names]    = (@scope[:path_names] || {}).merge(options[:path_names] || {})
+      options[:constraints]   = (@scope[:constraints] || {}).merge(options[:constraints] || {})
+      options[:defaults]      = (@scope[:defaults] || {}).merge(options[:defaults] || {})
+      options[:options]       = @scope[:options] || {}
+      options[:options][:format] = false if options[:format] == false
+
+      #puts "\n\n\n#{options.to_s}\n\n\n"
+
+      resources :bookmarks, only: [:create, :destroy, :index] do
+        collection do
+          get :get_users
+        end
+        member do
+          post :share
+        end
+      end
+
+    end
+  end
+end

data/lib/dog_ears/version.rb

@@ -0,0 +1,3 @@
+module DogEars
+  VERSION = "0.1.0 "
+end

data/lib/dog_ears.rb

@@ -0,0 +1,19 @@
+require "dog_ears/engine"
+require "dog_ears/controller"
+require "dog_ears/rails/routes"
+require "dog_ears/rails/helper"
+
+module DogEars
+
+  def self.bookmark(user, path, title, level=nil)
+    b = Bookmark.new do |b|
+      b.user = user
+      b.path = path
+      b.title = title.presence || path
+      b.level = level
+    end
+    b.save!
+    b
+  end
+
+end

data/lib/tasks/dog_ears_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :dog_ears do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: dog_ears
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Horn, Provideal GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generic in-app-bookmarks and bookmark-sharing based on URL routes.
+email:
+- ph@provideal.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/dog_ears/application.js
+- app/assets/stylesheets/dog_ears/application.css
+- app/controllers/dog_ears/application_controller.rb
+- app/helpers/application_helper.rb
+- app/models/dog_ears/bookmark.rb
+- app/views/dog_ears/_dog_ears.html.erb
+- app/views/layouts/dog_ears/application.html.erb
+- config/routes.rb
+- db/migrate/20130828134045_create_dog_ears_bookmarks.rb
+- lib/dog_ears/controller.rb
+- lib/dog_ears/engine.rb
+- lib/dog_ears/rails/helper.rb
+- lib/dog_ears/rails/routes.rb
+- lib/dog_ears/version.rb
+- lib/dog_ears.rb
+- lib/tasks/dog_ears_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: https://github.com/provideal/dog_ears
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Generic in-app-bookmarks and bookmark-sharing
+test_files: []
+has_rdoc: