ruby_pocket 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f563c1c1e135a1c47d268ecfdb1756b725024d90
+  data.tar.gz: d0d152035dcbd56324cc78c95b6c67595f8449ea
+SHA512:
+  metadata.gz: c51b5f705315b878fccc9791acf391e57e5f916eefb71fd2f6b8af84a6d77e1419d4d7d78dbca4c660f2e21b4a05479808c1af0896539ac282b6ae735f0e996c
+  data.tar.gz: 550e7671b2f70a3a98e5f307f90b12451b1b6df892711fae04941e4026a7d4876ff91dd895fedf81c52a6bf027d44f07540902537d39fcc33dca0840465f9bc5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 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.md

@@ -0,0 +1,191 @@
+# Ruby Pocket
+
+[![Code Climate](https://codeclimate.com/github/thiagoa/ruby_pocket/badges/gpa.svg)](https://codeclimate.com/github/thiagoa/ruby_pocket)
+[![Test Coverage](https://codeclimate.com/github/thiagoa/ruby_pocket/badges/coverage.svg)](https://codeclimate.com/github/thiagoa/ruby_pocket/coverage)
+[![Travis CI](https://travis-ci.org/thiagoa/ruby_pocket.svg)](https://travis-ci.org/thiagoa/ruby_pocket)
+
+*A warm place to store your precious development references.*
+
+Although it has *pocket* in its name, **Ruby Pocket** is not a **Pocket** nor a
+**Readability** clone. It is a tool designed to store useful all-around
+development articles and reference URLs. You can store any kind of URL, but its
+main appeal is for developers, or for those who need to store technical
+articles or references of any kind.
+
+Why would you want to use something like that? Having made this tool for
+myself, here are some reasons why you might want to use it too:
+
+- You feel like work and technical references should not be mixed with other
+  content types.
+- You don't want to clutter your bookmarks with technical references.
+- You don't want to clutter your **Pocket** or **Readability** account; they're
+  meant to be read later lists, not permanent article stores.
+- **You want to be the real owner, and have full control over your own data**.
+  **Ruby Pocket** uses **SQLite3**; that means you're not limited to weird
+  export formats, or to no export formats at all; you can do whatever you want
+  with your data.
+- You are a heavy command line user and lover, and don't want to break the flow
+  when looking for a reference.
+- You enjoy a clean, text-based, clutter-free list of favorites.
+- You want to have your URLs at your disposal, in all your computers, or even
+  have a private URL server. With a private URL server hosted in some place
+  like **Heroku**, you can also consume your content on mobile devices (*not
+  ready yet*).
+- You want power searching (*not ready yet*).
+
+If you're fine with your current method, whatever it is, just go with it :-)
+
+## Current Features
+
+Currently the app has a very simple feature set:
+
+- Simple and delightful command line interface.
+- Tagging support. Each favorite can have one or more tags.
+- Add favorites.
+- List favorites.
+- Search favorites by tags.
+- Delete favorites
+- Open favorites in the default browser (currently for **OS X**)
+
+## How to install
+
+There is no RubyGem yet. Just clone the repo and install the dependencies:
+
+```sh
+bundle install
+```
+
+The binary is located in `bin/pocket`.
+
+## Usage
+
+Note: there are verbose versions for all commands presented here. See all
+available options with the following command:
+
+```sh
+$ pocket -h
+```
+
+Add a favorite, fetching its name over the internet:
+
+```sh
+$ pocket -a https://github.com/jlevy/the-art-of-command-line
+
+Favorite 'jlevy/the-art-of-command-line · GitHub' created!
+```
+
+Add a favorite, but specify its name:
+
+```sh
+$ pocket -a https://github.com/jlevy/the-art-of-command-line -t 'The Art of Command Line'
+
+Favorite 'The Art of Command Line' created!
+```
+
+Add a favorite with tags. If more than one tag, separate with commas:
+
+```sh
+$ pocket -a https://github.com/jlevy/the-art-of-command-line -t command-line
+
+Favorite 'jlevy/the-art-of-command-line · GitHub' created!
+```
+
+List all favorites:
+
+```sh
+$ pocket -l
+
++----+------------------------------------------------------------------+--------------------+
+| ID | Name                                                             | Tags               |
++----+------------------------------------------------------------------+--------------------+
+| 1  | Stronger Shell                                                   | shell-script       |
+| 2  | The Art of Command Line                                          | command-line       |
++----+------------------------------------------------------------------+--------------------+
+```
+
+Filter favorites by tag. Can filter by more than one tag:
+
+```sh
+$ pocket -l -t command-line
+
++----+------------------------------------------------------------------+--------------------+
+| ID | Name                                                             | Tags               |
++----+------------------------------------------------------------------+--------------------+
+| 2  | The Art of Command Line                                          | command-line       |
++----+------------------------------------------------------------------+--------------------+
+```
+
+Open a favorite in your default browser. Use the ID of the favorite:
+
+```sh
+$ pocket -o 2
+```
+
+Delete favorites. Use the IDs of the favorites you want to delete, separated by
+commas:
+
+```sh
+$ pocket -d 2
+
+Favorite 'The Art of Command Line' deleted
+```
+
+## Planned Features
+
+- Scrape more web page information: probably the main content of the page.
+- Edit favorites.
+- List available tags.
+- Interactive command mode.
+- Search favorites with partial tag matching.
+- Search favorites by name or by content, with regex support.
+- Group favorites by tag, and other useful view modes.
+- Link database to another folder, such as **Dropbox**. That action shall be
+  automated with a command line flag.
+- Remote backup support.
+- **Linux** support for opening favorites.
+- **Sinatra** web app to consume the content on mobile devices (as another project, which uses the gem).
+- **Sinatra** API to consume the content (as another project, which uses the gem).
+- **Alfred** workflow (as another project).
+
+## Developer information
+
+This project is built with **Ruby**. The name **Ruby**, from **Ruby
+Pocket**, doesn't necessarily refer to the language itself :-)
+
+### Running the tests
+
+Unit tests:
+
+```sh
+rake test
+```
+
+Feature tests:
+
+```sh
+rake test:feature
+```
+
+All tests:
+
+```sh
+rake test:all
+
+# Works too
+rake
+```
+
+Run an IRB console:
+
+```sh
+rake console
+```
+
+## Contributing
+
+- Fork the project
+- Create a feature branch
+- Make your code changes with tests
+- Make a Pull-Request
+
+This project uses MIT\_LICENSE

data/Rakefile

@@ -0,0 +1,51 @@
+require 'pathname'
+require 'rake'
+
+%w(config lib test).each do |dir|
+  $LOAD_PATH << Pathname(__dir__).join(dir)
+end
+
+def run_tests(test_files)
+  require 'minitest'
+
+  test_files.each { |file | require file.expand_path }
+
+  Minitest.run
+end
+
+desc 'Run unit tests'
+task :test do
+  all = Pathname.glob('test/**/*_test.rb')
+
+  run_tests(all.reject { |f| f.to_s =~ /features/ })
+end
+
+namespace :test do
+  desc 'Run feature tests'
+  task :feature do
+    feature = Pathname.glob('test/ruby_pocket/features/**/*_test.rb')
+
+    run_tests(feature)
+  end
+
+  desc 'Run all tests'
+  task :all do
+    all = Pathname.glob('test/**/*_test.rb')
+
+    run_tests(all)
+  end
+end
+
+desc 'Run an IRB console'
+task :console do |t|
+  require 'irb'
+  require 'ruby_pocket'
+  require 'config'
+  require 'ruby_pocket/all'
+
+  ARGV.clear
+
+  IRB.start
+end
+
+task default: 'test:all'

data/config/config.rb

@@ -0,0 +1,14 @@
+RubyPocket.environment = ENV['RUBY_POCKET_ENV'] if ENV['RUBY_POCKET_ENV']
+RubyPocket.setup_data_dir
+
+require 'forwardable'
+require 'sqlite3'
+require 'sequel'
+require 'terminal-table'
+
+if RubyPocket.environment.test? && ENV['MOCK_FEATURE'] == 'add'
+  require_relative '../test/support/add_feature_mocker'
+  AddFeatureMocker.new.run
+end
+
+require_relative 'database'

data/config/database.rb

@@ -0,0 +1,14 @@
+db_path = if RubyPocket.environment.production?
+            [RubyPocket.data_dir, 'pocket_production.db']
+          else
+            ['db', "pocket_#{RubyPocket.environment.downcase}.db"]
+          end
+
+DB = Sequel.connect("sqlite://#{File.join(*db_path)}")
+
+Sequel::Model :validation_helpers
+Sequel.extension :migration
+
+unless Sequel::Migrator.is_current?(DB, 'db/migrations')
+  Sequel::Migrator.run(DB, 'db/migrations')
+end

data/db/migrations/001_create_tags.rb

@@ -0,0 +1,15 @@
+Sequel.migration do
+  up do
+    unless table_exists?(:tags)
+      create_table :tags do
+        primary_key :id
+
+        String :name, unique: true
+      end
+    end
+  end
+
+  down do
+    drop_table :tags
+  end
+end

data/db/migrations/002_create_favorites.rb

@@ -0,0 +1,17 @@
+Sequel.migration do
+  up do
+    unless table_exists?(:favorites)
+      create_table :favorites do
+        primary_key :id
+
+        String :name, text: true
+        String :summary, text: true
+        String :url, text: true, unique: true
+      end
+    end
+  end
+
+  down do
+    drop_table :favorites
+  end
+end

data/db/migrations/003_create_favorites_tags.rb

@@ -0,0 +1,20 @@
+Sequel.migration do
+  up do
+    run <<-SQL
+    CREATE TABLE IF NOT EXISTS favorites_tags(
+      id INTEGER PRIMARY KEY AUTOINCREMENT,
+      tag_id INTEGER,
+      favorite_id INTEGER,
+      FOREIGN KEY(tag_id) REFERENCES tags(id) ON DELETE CASCADE,
+      FOREIGN KEY(favorite_id) REFERENCES favorites(id) ON DELETE CASCADE,
+      UNIQUE(tag_id, favorite_id) ON CONFLICT REPLACE
+    )
+    SQL
+  end
+
+  down do
+    run <<-SQL
+    DROP TABLE favorites_tags
+    SQL
+  end
+end

data/lib/ruby_pocket/all.rb

@@ -0,0 +1,5 @@
+require 'ruby_pocket'
+
+Dir.glob(File.join(__dir__, '**', '*.rb')).each do |file|
+  require file
+end

data/lib/ruby_pocket/cli/add_action.rb

@@ -0,0 +1,12 @@
+module RubyPocket
+  module Cli
+    class AddAction
+      def call(options)
+        creator = FavoriteCreator.new(options.values)
+        creator.save
+
+        puts "Favorite '#{creator.name}' created!"
+      end
+    end
+  end
+end

data/lib/ruby_pocket/cli/delete_action.rb

@@ -0,0 +1,16 @@
+module RubyPocket
+  module Cli
+    class DeleteAction
+      def call(options)
+        options.values[:ids].each do |id|
+          favorite = Favorite[id]
+
+          next puts "Favorite with ID #{id} not found!" unless favorite
+
+          favorite.destroy
+          puts "Favorite '#{favorite.name}' deleted"
+        end
+      end
+    end
+  end
+end

data/lib/ruby_pocket/cli/list_action.rb

@@ -0,0 +1,39 @@
+require 'ruby_pocket/favorite_query'
+
+module RubyPocket
+  module Cli
+    class ListAction
+      def call(options)
+        favorites = FavoriteQuery.where(options.values).all
+        render favorites
+      end
+
+      private
+
+      def render(favorites)
+        return puts 'Your Ruby Pocket is empty' if favorites.empty?
+
+        headings = %w(ID Name Tags)
+        rows = table_rows(favorites)
+
+        puts Terminal::Table.new headings: headings, rows: rows
+      end
+
+      def table_rows(favorites)
+        rows = favorites.map do |f|
+          [f.id, f.name, f.tags.map(&:name).join(',')]
+        end
+
+        add_placeholders(rows)
+      end
+
+      def add_placeholders(rows)
+        rows.each do |row|
+          row.map! do |value|
+            (value.to_s.empty? && '-') || value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby_pocket/cli/open_action.rb

@@ -0,0 +1,12 @@
+module RubyPocket
+  module Cli
+    class OpenAction
+      def call(options)
+        favorite = Favorite[options.values[:id]]
+        fail ArgumentError, 'Favorite not found!' unless favorite
+
+        %x(open #{favorite.url})
+      end
+    end
+  end
+end

data/lib/ruby_pocket/cli/options.rb

@@ -0,0 +1,23 @@
+module RubyPocket
+  module Cli
+    class Options
+      attr_reader :action, :values
+
+      def initialize
+        @values = {}
+      end
+
+      def action=(action)
+        if @action
+          fail ArgumentError, "Can't #{action} and #{@action} at the same time"
+        end
+
+        @action = action
+      end
+
+      def validate!
+        fail ArgumentError, 'You need to supply an action' unless action
+      end
+    end
+  end
+end

data/lib/ruby_pocket/cli.rb

@@ -0,0 +1,8 @@
+module RubyPocket
+  module Cli
+    def self.dispatch(options)
+      action = const_get("#{options.action.to_s.capitalize}Action")
+      action.new.call options
+    end
+  end
+end

data/lib/ruby_pocket/environment.rb

@@ -0,0 +1,11 @@
+module RubyPocket
+  class Environment < String
+    ALL = %w(PRODUCTION DEVELOPMENT TEST)
+
+    ALL.each do |env|
+      define_method "#{env.downcase}?" do
+        self == env
+      end
+    end
+  end
+end

data/lib/ruby_pocket/favorite.rb

@@ -0,0 +1,36 @@
+require 'ruby_pocket/tag'
+
+module RubyPocket
+  class Favorite < Sequel::Model
+    plugin :validation_helpers
+
+    many_to_many :tags
+
+    attr_writer :tag_names
+
+    def tag_names
+      @tag_names ||= [*@tag_names]
+    end
+
+    private
+
+    def validate
+      validates_presence :url
+      validates_unique :url
+    end
+
+    def before_save
+      name.strip! if name
+    end
+
+    def after_create
+      create_tags
+    end
+
+    def create_tags
+      tag_names.each do |name|
+        add_tag Tag.find_or_create(name: name)
+      end
+    end
+  end
+end

data/lib/ruby_pocket/favorite_creator.rb

@@ -0,0 +1,62 @@
+require 'ruby_pocket/favorite'
+require 'delegate'
+
+module RubyPocket
+  ValidationError = Class.new RubyPocketError
+
+  class FavoriteCreator
+    extend Forwardable
+
+    attr_accessor :web_page
+
+    delegate :name => :favorite
+
+    def initialize(params)
+      @params = params
+    end
+
+    def favorite=(favorite)
+      fail 'Must be a new favorite' unless favorite.new?
+      @favorite = favorite
+    end
+
+    def save
+      fetch_missing_data
+      assign_params
+      save_favorite
+    end
+
+    private
+
+    def fetch_missing_data
+      return if @params[:name]
+      return unless web_page_contents
+
+      @params[:name] = web_page_contents.title
+    end
+
+    def web_page_contents
+      return unless @params[:url]
+
+      @page ||= web_page.for(@params[:url])
+    end
+
+    def assign_params
+      favorite.set_all @params
+    end
+
+    def save_favorite
+      favorite.save
+    rescue Sequel::ValidationFailed => e
+      raise ValidationError, e.message
+    end
+
+    def favorite
+      @favorite ||= Favorite.new
+    end
+
+    def web_page
+      @web_page ||= WebPage
+    end
+  end
+end

data/lib/ruby_pocket/favorite_query.rb

@@ -0,0 +1,34 @@
+require 'ruby_pocket/favorite'
+
+module RubyPocket
+  class FavoriteQuery
+    extend Forwardable
+
+    def self.where(options)
+      new.where(options)
+    end
+
+    delegate :all => :@scope
+
+    def initialize(scope = nil)
+      @scope = scope || Favorite
+    end
+
+    def where(options)
+      if options[:tag_names]
+        tags = Tag.find_all(options[:tag_names])
+        @scope = where_tags(tags)
+      end
+
+      self
+    end
+
+    private
+
+    def where_tags(tags)
+      tags.reduce(@scope) do |scope, tag|
+        scope.where(tags: tag)
+      end
+    end
+  end
+end

data/lib/ruby_pocket/tag.rb

@@ -0,0 +1,32 @@
+module RubyPocket
+  class Tag < Sequel::Model
+    plugin :validation_helpers
+
+    def self.find_all(names)
+      names.map do |name|
+        find(name: name).tap do |tag|
+          fail ArgumentError, "Tag #{name} not found" unless tag
+        end
+      end
+    end
+
+    def name=(name)
+      super parameterize_name(name)
+    end
+
+    private
+
+    def parameterize_name(name)
+      name
+        .downcase
+        .strip
+        .gsub(/\s+/, ' ')
+        .gsub(/[^a-z]/, '-')
+        .gsub(/-+/, '-')
+    end
+
+    def validate
+      validates_unique :name
+    end
+  end
+end

data/lib/ruby_pocket/version.rb

@@ -0,0 +1,3 @@
+module RubyPocket
+  VERSION = '0.1.1'
+end