noty 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92ebd84abb7bd6e2244b75cbb9702ad4fae00813
-  data.tar.gz: 9c3767b0bda13dbe2b23afe18e511463343d2739
+  metadata.gz: 1ee94f9f7f6768a48b1797a647e0f7db4b3f9875
+  data.tar.gz: 0e490608feb4bef1374a4683a15e8430647aacbd
 SHA512:
-  metadata.gz: 89042c9ce2695f8410c2f890137701c8e3743156f509d5e719dc32343a215c89fa6488c478a7e4ddc740ca6a301865032c3aac385e1eae566fdc4ffd9165487b
-  data.tar.gz: bcce25349a539868bb0709a7dd4000f878b27e6c2688c64dfdf874e97f18b6f5838563f05d62a259b74de7e50ae0bff2c45425624096d1a84d9eb457a68b4008
+  metadata.gz: 34bb28fd6ea2e39789a0e9f73a2c8a0665cae5e10a5a0ffc513735a21a38e97d360f04a1163bdb8b1b79b81af972795f3235e077d45c2a07129545269755bbce
+  data.tar.gz: c2d8c9c6b976d8bde17d18e558b7f4ea40664dcc9424c7c9f234f9f9ce88bc84b7d8d6b5b397f49c574e7da434407200106d97b5e71aaaa19fdb628945a46238

data/README.md

@@ -20,6 +20,14 @@ $ gem install noty
 1. xsel : could be found on most distros official repositories
 2. xdg-open : should be installed with most opendesktop compatible desktop environments
 
+## Environment
+
+by default Noty saves your files in `~/.notes` if you want to change that path, define an Environment variable in your shell init file `.bashrc` or `.zshrc`
+
+```bash
+export NOTES_PATH=/path/to/your/notes/dir
+```
+
 
 ## Usage
 
@@ -36,6 +44,28 @@ Snippets and bookmarks manager.
 2. **keyword:** search bookmarks and perform action on it, a single word of multiple words or regex, it is passed to "ag silver searcher"
 3. **snippet text:** any multiword text, it will search first if no files contain this text you'll be asked if you want to create a snippet for it
 
+## Examples
+
+Add a bookmark
+```bash
+noty https://www.youtube.com
+```
+
+Search for bookmark
+```bash
+noty youtube
+```
+
+Add a snippet text
+```bash
+noty this is a long text that I need to save in my stash
+```
+
+Search for a snippet (same as searching for bookmarks)
+```bash
+noty need
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/blazeeboy/noty.

data/exe/noty

@@ -1,167 +1,15 @@
 #!/usr/bin/env ruby
-require 'open-uri'
-require 'yaml'
-require 'fileutils'
-require 'io/console'
 
-STORAGE = File.expand_path(ENV['NOTES_PATH'] || '~/.notes')
-FileUtils.mkdir_p STORAGE
-
-# ------------------------------------------
-# HELPERS
-# ------------------------------------------
-
-def edit(file_path)
-  editor = ENV['EDITOR'] || 'vi'.freeze
-  system "#{editor} #{file_path}"
-end
-
-def copy(file)
-  case RUBY_PLATFORM
-  when /darwin/
-    `cat #{file} | pbcopy`
-  when /linux/
-    `cat #{file} | xsel --clipboard --input`
-  end
-end
-
-def open_url(url)
-  case RUBY_PLATFORM
-  when /darwin/
-    system "open #{url}"
-  when /linux/
-    system "xdg-open #{url}"
-  end
-end
-
-# ------------------------------------------
-# PRESENTATION METHODS
-# ------------------------------------------
-
-def short_display(file)
-  case File.extname(file)
-  when '.bookmark'
-    content = YAML.load_file(file)
-    puts content['title'].to_s + ' (' + content['url'].to_s + ')'
-  when '.snippet'
-    content = File.read(file)
-    puts content.tr("\n", ' ')[0..100]
-  else
-    puts File.open(file).read(100).to_s.lines.first
-  end
-end
-
-def long_display(file)
-  puts File.read(file)
-end
-
-def choose(files)
-  if files.empty?
-    exit 0
-  elsif files.one?
-    long_display files.first
-    operations(files.first)
-  else
-
-    files.each_with_index do |file, index|
-      print "#{index + 1}. "
-      short_display file
-    end
-
-    print '-> (1..9) or Q to exit: '
-    puts choice = $stdin.getch
-
-    case choice
-    when 'q'
-      exit 0
-    when /\A[1-9]\z/
-      long_display files[choice.to_i - 1]
-      operations(files[choice.to_i - 1])
-    end
-  end
-end
-
-def operations(file)
-  print '[E]dit [D]elete [O]pen [C]opy, Else to Quit: '
-  puts choice = $stdin.getch
-
-  case choice
-  when 'e'
-    edit file
-  when 'd'
-    File.delete file
-  when 'o'
-    content = YAML.load_file(file)
-    open_url content['url']
-  when 'c'
-    copy file
-  else
-    exit 0
-  end
-end
-
-def create_snippet(text)
-  print 'Do you want to save it as a snippet? [y/N]: '
-  puts choice = $stdin.getch
-  return unless choice.casecmp 'y'
-
-  file_path = File.join(STORAGE, Time.now.to_i.to_s + '.snippet')
-  File.write(file_path, text)
-end
-
-# -----------------------------------------------------------
-# TOP LEVEL COMMANDS
-# -----------------------------------------------------------
-def help
-  exec_name = File.basename(__FILE__)
-  puts <<-EOT
-Snippets and bookmarks manager.
-Usage:
-  #{exec_name} [command|inputs]
-
-Commands:
-  #{exec_name} help, --help : print this message
-
-Input types:
-  url: e.g "http://www.example.com", add URL as a bookmark file
-  keyword: search bookmarks and perform action on it, a single word of multiple words or regex, it is passed to "ag silver searcher"
-  snippet text: any multiword text, it will search first if no files contain this text you'll be asked if you want to create a snippet for it
-EOT
-end
-
-def bookmark
-  url = ARGV.first
-  content = begin
-              open(url).read
-            rescue
-              ""
-            end
-  file_path = File.join(STORAGE, Time.now.to_i.to_s + '.bookmark')
-  bookmark_object = {
-    'url' => url,
-    'title' => content.match(%r{<title>(.+)<\/title>}im).to_a[1]
-  }
-  File.write(file_path, bookmark_object.to_yaml)
-  edit file_path
-end
-
-def search
-  keyword = ARGV.join ' '
-  files = `ag -l "#{keyword}" #{STORAGE}`.lines
-  top_matches = files[0...9].map(&:chomp)
-
-  if top_matches.empty? && keyword.include?(' ')
-    create_snippet(keyword)
-  else
-    choose top_matches
-  end
-end
-
-send case ARGV.first
-     when /\Ahttp/
-       :bookmark
-     when 'help', '--help'
-       :help
-     else
-       :search
-     end
+$LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + '/../lib')
+require 'noty'
+
+Noty.send case ARGV.first
+          when /\Ahttp/
+            :bookmark
+          when 'help', '-h', '--help'
+            :help
+          when 'version', '-v', '--version'
+            :version
+          else
+            :search
+          end

data/lib/noty.rb

@@ -1,5 +1,60 @@
-require "noty/version"
+require 'noty/version'
+require 'noty/ui'
+require 'noty/storage'
+require 'noty/models/bookmark'
+require 'noty/models/snippet'
+require 'noty/services/search'
 
 module Noty
-  # Your code goes here...
+  module_function
+
+  def version
+    puts "Noty version #{VERSION}"
+  end
+
+  def help
+    version
+    puts <<-EOT
+Snippets and bookmarks manager.
+
+Usage:
+  noty [command|inputs]
+
+Commands:
+  help, -h, --help : print this message
+  version, -v, --version : print noty version
+
+Input types:
+  url: e.g "http://www.example.com", add URL as a bookmark file
+  keyword: search bookmarks and perform action on it, a single word of multiple words or regex, it is passed to "ag silver searcher"
+  snippet text: any multiword text, it will search first if no files contain this text you'll be asked if you want to create a snippet for it
+EOT
+  end
+
+  def search
+    keyword = ARGV.join ' '
+    result = Services.search(keyword)
+
+    if !result.empty?
+      UI.choose result
+    elsif keyword.include?(' ')
+      choice = ask 'Do you want to save it as a snippet? [y/N]: '
+      snippet if choice.casecmp 'y'
+    end
+  end
+
+  def snippet
+    content = ARGV.join ' '
+    path = File.join(Noty::STORAGE_PATH, Time.now.to_i.to_s + '.snippet')
+
+    snippet = Snippet.new(path)
+    snippet.content = content
+    snippet.save
+  end
+
+  def bookmark
+    bm = Bookmark.from_url(ARGV.first)
+    bm.save
+    bm.edit
+  end
 end

data/lib/noty/ask.rb

@@ -0,0 +1,7 @@
+require 'io/console'
+
+def ask(question)
+  print question
+  puts choice = $stdin.getch
+  choice
+end

data/lib/noty/helpers.rb

@@ -0,0 +1,30 @@
+require 'open3'
+
+module Noty
+  module Helpers
+    module_function
+
+    def edit(file_path)
+      editor = ENV['EDITOR'] || 'vi'.freeze
+      system "#{editor} #{file_path}"
+    end
+
+    def copy(text)
+      case RUBY_PLATFORM
+      when /darwin/
+        Open3.capture2('pbcopy', stdin_data: text)
+      when /linux/
+        Open3.capture2('xsel --clipboard --input', stdin_data: text)
+      end
+    end
+
+    def open_url(url)
+      case RUBY_PLATFORM
+      when /darwin/
+        system "open #{url}"
+      when /linux/
+        system "xdg-open #{url}"
+      end
+    end
+  end
+end

data/lib/noty/models/bookmark.rb

@@ -0,0 +1,64 @@
+require 'open-uri'
+require 'yaml'
+require 'noty/storage'
+require 'noty/helpers'
+
+module Noty
+  class Bookmark
+    attr_accessor :path, :url, :title
+
+    def initialize(path)
+      content = File.exist?(path) ? YAML.load_file(path) : ''
+
+      @path = path
+      @url = content['url']
+      @title = content['title']
+    end
+
+    def self.from_url(url)
+      file_path = File.join(STORAGE_PATH, Time.now.to_i.to_s + '.bookmark')
+      content = begin
+                  open(url).read
+                rescue
+                  ''
+                end
+      bookmark = new(file_path)
+      bookmark.url = url
+      bookmark.title = content.match(%r{<title>(.+)<\/title>}im).to_a[1]
+      bookmark
+    end
+
+    def save
+      File.write(path, to_yaml)
+    end
+
+    def delete
+      File.delete path
+    end
+
+    def open
+      Helpers.open_url url
+    end
+
+    def edit
+      Helpers.edit path
+    end
+
+    def copy
+      Helpers.copy url
+    end
+
+    def to_s(short = false)
+      short ? title.to_s : "#{title} (#{url})"
+    end
+
+    private
+
+    def to_yaml
+      {
+        'url' => url,
+        'title' => title
+      }.to_yaml
+    end
+  end
+end

data/lib/noty/models/snippet.rb

@@ -0,0 +1,37 @@
+require 'noty/storage'
+require 'noty/helpers'
+
+module Noty
+  class Snippet
+    attr_accessor :path, :content
+
+    def initialize(path)
+      @path = path
+      @content = File.exist?(path) ? File.read(path) : ''
+    end
+
+    def save
+      File.write(path, content)
+    end
+
+    def delete
+      File.delete path
+    end
+
+    def open
+      edit
+    end
+
+    def copy
+      Helpers.copy content
+    end
+
+    def edit
+      Helpers.edit path
+    end
+
+    def to_s(short = false)
+      short ? content.tr("\n", ' ')[0..100] : content.to_s
+    end
+  end
+end

data/lib/noty/services/search.rb

@@ -0,0 +1,18 @@
+module Noty
+  module Services
+    module_function
+
+    def search(keyword)
+      files = `ag -l "#{keyword}" #{STORAGE_PATH}`.lines
+      top_matches = files[0...9].map(&:chomp)
+      top_matches.map do |file|
+        case File.extname(file)
+        when '.bookmark'
+          Bookmark.new(file)
+        when '.snippet'
+          Snippet.new(file)
+        end
+      end
+    end
+  end
+end

data/lib/noty/storage.rb

@@ -0,0 +1,6 @@
+require 'fileutils'
+
+module Noty
+  STORAGE_PATH = File.expand_path(ENV['NOTES_PATH'] || '~/.notes')
+  FileUtils.mkdir_p STORAGE_PATH
+end

data/lib/noty/ui.rb

@@ -0,0 +1,43 @@
+require 'noty/ask'
+
+module Noty
+  module UI
+    module_function
+
+    def choose(objects)
+      return if objects.empty?
+
+      if objects.one?
+        puts objects.first.to_s(false)
+        operations(objects.first)
+      else
+
+        objects.each_with_index do |object, index|
+          puts "#{index + 1}. " + object.to_s(true)
+        end
+
+        choice = ask '-> (1..9) or else to exit: '
+
+        if choice =~ /\A[1-9]\z/
+          puts objects[choice.to_i - 1].to_s(false)
+          operations(objects[choice.to_i - 1])
+        end
+      end
+    end
+
+    def operations(object)
+      case ask '[E]dit [D]elete [O]pen [C]opy, Else to Quit: '
+      when 'e'
+        object.edit
+      when 'd'
+        object.delete
+      when 'o'
+        object.open
+      when 'c'
+        object.copy
+      else
+        exit 0
+      end
+    end
+  end
+end

data/lib/noty/version.rb

@@ -1,3 +1,3 @@
 module Noty
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noty
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Emad Elsaid
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-04 00:00:00.000000000 Z
+date: 2017-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,14 @@ description: |
   1. xsel : could be found on most distros official repositories
   2. xdg-open : should be installed with most opendesktop compatible desktop environments
 
+  ## Environment
+
+  by default Noty saves your files in `~/.notes` if you want to change that path, define an Environment variable in your shell init file `.bashrc` or `.zshrc`
+
+  ```bash
+  export NOTES_PATH=/path/to/your/notes/dir
+  ```
+
 
   ## Usage
 
@@ -91,6 +99,28 @@ description: |
   2. **keyword:** search bookmarks and perform action on it, a single word of multiple words or regex, it is passed to "ag silver searcher"
   3. **snippet text:** any multiword text, it will search first if no files contain this text you'll be asked if you want to create a snippet for it
 
+  ## Examples
+
+  Add a bookmark
+  ```bash
+  noty https://www.youtube.com
+  ```
+
+  Search for bookmark
+  ```bash
+  noty youtube
+  ```
+
+  Add a snippet text
+  ```bash
+  noty this is a long text that I need to save in my stash
+  ```
+
+  Search for a snippet (same as searching for bookmarks)
+  ```bash
+  noty need
+  ```
+
   ## Contributing
 
   Bug reports and pull requests are welcome on GitHub at https://github.com/blazeeboy/noty.
@@ -115,6 +145,13 @@ files:
 - bin/setup
 - exe/noty
 - lib/noty.rb
+- lib/noty/ask.rb
+- lib/noty/helpers.rb
+- lib/noty/models/bookmark.rb
+- lib/noty/models/snippet.rb
+- lib/noty/services/search.rb
+- lib/noty/storage.rb
+- lib/noty/ui.rb
 - lib/noty/version.rb
 - noty.gemspec
 homepage: https://www.github.com/blazeeboy/noty