annoyme 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 64a20eedf2647f8cd1de544ece4a3ba4f8e98a7c
+  data.tar.gz: f14e95cac86d57dcb707e8207c018753001bafd9
+SHA512:
+  metadata.gz: 92632828639cf0789079a49e74450778d2bec77012cce293a5c67b75699c492bdd3f59c974a6687cfbc1c0a30b59bd3441f781c0d289604b1b80f6fb78d10446
+  data.tar.gz: cba1b2c7f62ee6082001a057fa55745ba387dc601a3158ff9dd6f67d4c71376b655d3f193c3dbcd5d65d63957dd9236237fb3c828acce075326c510757c22f20

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+-fdoc

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start do
+  add_filter '/spec/'
+end

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at christian.paling@googlemail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in annoyme.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,4 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  watch(/^lib\/annoyme\/(.*)\.rb/) { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/(.+)\.rb$})
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Christian Paling
+
+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,51 @@
+# Annoyme
+
+Annoyme is basically `echo "Buy present for mom" >> .bashrc` in an improved form. It is a small tool to write notes or todos on the command line and have them listed each time a new terminal gets opened.
+
+## Installation
+
+Run
+
+    $ gem install annoyme
+
+to install annoyme on your local machine.
+
+## Usage
+
+After installation, annoyme has to register itself in your specific shell. Currently `zsh` and `bash` are supported. Furthermore annoyme will create a file to which it will save its notes. This file is located at `$HOME/.annoyme`. To do all of this initialization work the program provides an `init` command:
+
+    $ annyome init
+    
+New notes/todos can be added afterwards:
+
+    $ annoyme add "Buy mom a present"
+    	added		Buy mom a present
+    $ annoyme add "Make an appointment with dentist"
+        added       Make an appointment with dentist
+    
+Open a new terminal:
+
+    Last login: Sat Feb 18 10:50:35 on ttys004
+
+    TODO
+
+        1.	Buy mom a present
+        2.	Make an appointment with dentist
+
+Remove notes:
+
+    $ annoyme remove 1
+        deleted     Buy mom a present
+    
+## Development
+
+Annoyme uses `guard` and `rspec` as testing tools. Guard will run for each change only the specs of the file that was modified.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bakku/annoyme. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/annoyme.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'annoyme/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'annoyme'
+  spec.version       = Annoyme::VERSION
+  spec.authors       = ['Christian Paling']
+  spec.email         = ['christian.paling@googlemail.com']
+
+  spec.summary       = %q{helpfully annoys you on your command line}
+  spec.homepage      = 'https://github.com/bakku/annoyme'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'guard-rspec', '4.7'
+  spec.add_development_dependency 'terminal-notifier-guard'
+  spec.add_development_dependency 'simplecov', '~> 0.12'
+  spec.add_runtime_dependency     'thor', '~> 0.19'
+  spec.add_runtime_dependency     'rainbow', '~> 2.1'
+end

data/exe/annoyme

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib)
+
+require 'annoyme'
+
+Annoyme.execute

data/lib/annoyme.rb

@@ -0,0 +1,10 @@
+require 'annoyme/version'
+require 'annoyme/cli'
+
+module Annoyme
+  DEFAULT_NOTES_FILE = "#{ENV['HOME']}/.annoyme"
+
+  def self.execute
+    CLI.start(ARGV)
+  end
+end

data/lib/annoyme/adder.rb

@@ -0,0 +1,16 @@
+require_relative 'logger'
+
+module Annoyme
+  class Adder
+    def initialize(file)
+      @file = file
+    end
+
+    def add(note)
+      notes = @file.parse
+      notes << note
+      @file.write(notes)
+      Logger.green('added', note)
+    end
+  end
+end

data/lib/annoyme/cli.rb

@@ -0,0 +1,80 @@
+require 'thor'
+
+require_relative 'notes_file'
+require_relative 'initializer'
+require_relative 'adder'
+require_relative 'remover'
+require_relative 'printer'
+
+require_relative 'error/config_file_does_not_exist_error'
+
+module Annoyme
+  class CLI < Thor
+    desc 'init', 'initialize your annoyme instance'
+    long_desc <<-LONG_DESC
+      `annoyme init` will initialize an .annoyme file in your
+      home directory and link it with your .bashrc/.zshrc file.
+      It will store your notes as echo commands there which will be
+      printed out whenever you start a new terminal
+    LONG_DESC
+    def init
+      initializer = Initializer.new(notes_file)
+      initializer.perform
+    end
+
+    desc 'add NOTE', 'add NOTE to your terminal notes'
+    long_desc <<-LONG_DESC
+      `annoyme add` adds a new note to your terminal notes. Make sure that you
+      are passing the required note correctly.
+
+      Example Usage:
+
+      $ annoyme add "Buy mom a present"
+    LONG_DESC
+    def add(note)
+      check_config_file
+      Adder.new(notes_file).add(note)
+    end
+
+    desc 'remove NOTE', 'remove the note given by its number'
+    long_desc <<-LONG_DESC
+      `annoyme remove` removes a note from your terminal notes. It expects the
+      number of the note to be passed to the command.
+
+      Example Usage:
+
+      $ annoyme remove 1
+    LONG_DESC
+    def remove(note)
+      check_config_file
+      Remover.new(notes_file).remove(note)
+    end
+
+    desc 'print', 'prints all notes - will be placed in .bashrc/.zshrc file'
+    long_desc <<-LONG_DESC
+      `annoyme print` prints all stored notes to the terminal. This command is
+      generally written into your shellfile when using annoyme to print all
+      notes whenever you open a new terminal
+
+      Example Usage:
+
+      $ annoyme print
+    LONG_DESC
+    def print
+      check_config_file
+      Printer.new(notes_file).print
+    end
+
+    private
+
+    def check_config_file
+      unless notes_file.exists?
+        raise Error::ConfigFileDoesNotExistError, 'The annoyme file does not exist. Try running `annoyme init`'
+      end
+    end
+
+    def notes_file
+      @notes_file ||= NotesFile.new(DEFAULT_NOTES_FILE)
+    end
+  end
+end

data/lib/annoyme/error/config_file_does_not_exist_error.rb

@@ -0,0 +1,11 @@
+module Annoyme
+
+  module Error
+
+    class ConfigFileDoesNotExistError < RuntimeError
+
+    end
+
+  end
+  
+end

data/lib/annoyme/error/shell_not_supported_error.rb

@@ -0,0 +1,11 @@
+module Annoyme
+
+  module Error
+
+    class ShellNotSupportedError < RuntimeError
+
+    end
+
+  end
+
+end

data/lib/annoyme/initializer.rb

@@ -0,0 +1,47 @@
+require_relative 'logger'
+require_relative 'shell_file_appender'
+require_relative 'error/shell_not_supported_error'
+
+module Annoyme
+  class Initializer
+    def initialize(file)
+      @notes_file = file
+      detect_shell
+    end
+
+    def perform
+      create_annoyme_file
+      add_annoyme_print_to_shell_file
+    end
+
+    private
+
+    def detect_shell
+      case ENV['SHELL']
+      when '/bin/bash'
+        @shell = :bash
+        @file = File.join(ENV['HOME'], '.bashrc')
+      when '/bin/zsh'
+        @shell = :zsh
+        @file = File.join(ENV['HOME'], '.zshrc')
+      else
+        raise Error::ShellNotSupportedError, 'Your shell is not supported by annoyme. You can submit an issue at the github page'
+      end
+    end
+
+    def create_annoyme_file
+      if @notes_file.exists?
+        Logger.red('replaced', '.annoyme')
+      else
+        Logger.green('created', '.annoyme')
+      end
+
+      @notes_file.create
+    end
+
+    def add_annoyme_print_to_shell_file
+      appender = ShellFileAppender.new(@file)
+      appender.append_command
+    end
+  end
+end

data/lib/annoyme/logger.rb

@@ -0,0 +1,52 @@
+require 'rainbow'
+
+module Annoyme
+  class Logger
+    def self.green(change, text)
+      puts "#{Rainbow("\t#{change}\t").green.bright}\t#{text}" unless silent?
+    end
+
+    def self.red(change, text)
+      puts "#{Rainbow("\t#{change}\t").red.bright}\t#{text}" unless silent?
+    end
+
+    def self.yellow(change, text)
+      puts "#{Rainbow("\t#{change}\t").yellow.bright}\t#{text}" unless silent?
+    end
+
+    def self.colored(text, color)
+      puts Rainbow(text).send(color) unless silent?
+    end
+
+    def self.print_array_colorful(array, with_index: false)
+      unless silent?
+        array.each_with_index do |element, i|
+          if with_index
+            colored("  #{i+1}.\t#{element}", current_colorful_color(i))
+          else
+            colored("  #{element}", current_colorful_color(i))
+          end
+        end
+      end
+    end
+
+    private
+
+    def self.silent?
+      ENV['SILENT'] == 'true'
+    end
+
+    def self.current_colorful_color(i)
+      colorful_hash[i % 4]
+    end
+
+    def self.colorful_hash
+      {
+        0 => :green,
+        1 => :red,
+        2 => :yellow,
+        3 => :cyan
+      }
+    end
+  end
+end

data/lib/annoyme/notes_file.rb

@@ -0,0 +1,32 @@
+require 'json'
+
+module Annoyme
+  class NotesFile
+    def initialize(path)
+      @path = path
+    end
+
+    def create
+      File.open(@path, 'w') do |f|
+        f.write("[]")
+      end
+    end
+
+    def exists?
+      File.exist?(@path)
+    end
+
+    def parse
+      content = File.readlines(@path).first
+      JSON.parse(content)
+    rescue JSON::ParserError
+      raise 'notes file seems to be corrupted'
+    end
+
+    def write(content)
+      File.open(@path, 'w') do |f|
+        f.write(content)
+      end
+    end
+  end
+end

data/lib/annoyme/printer.rb

@@ -0,0 +1,20 @@
+require_relative 'logger'
+
+module Annoyme
+  class Printer
+    def initialize(file)
+      @file = file
+    end
+
+    def print
+      notes = @file.parse
+
+      return if notes.empty?
+
+      puts ""
+      Logger.colored("TODO\n", :cyan)
+      Logger.print_array_colorful(notes, with_index: true)
+      puts ""
+    end
+  end
+end

data/lib/annoyme/remover.rb

@@ -0,0 +1,37 @@
+require_relative 'logger'
+
+module Annoyme
+  class Remover
+    def initialize(file)
+      @file = file
+    end
+
+    def remove(note)
+      notes = @file.parse
+
+      if is_number?(note)
+        note = notes.delete_at((note.to_i - 1))
+
+        if note.nil?
+          Logger.red('error', 'Seems like your specified number was out of index')
+          return
+        end
+
+        @file.write(notes)
+        Logger.red('deleted', "#{note}")
+      else
+        Logger.red('error', 'You did not specify a note using a number')
+      end
+    end
+
+    private
+
+    def is_number?(string)
+      if Float(string)
+        true
+      end
+    rescue
+      false
+    end
+  end
+end

data/lib/annoyme/shell_file_appender.rb

@@ -0,0 +1,38 @@
+require_relative 'logger'
+
+module Annoyme
+  class ShellFileAppender
+    COMMAND_TO_APPEND = 'annoyme print'
+
+    def initialize(path)
+      raise 'shellfile does not exist' unless File.exist?(path)
+      @path = path
+    end
+
+    def append_command
+      if command_missing?
+        append_annoyme_command
+        Logger.yellow('modified', @path.split('/').last)
+      end
+    end
+
+    private
+
+    def command_missing?
+      File.foreach(@path) do |line|
+        if line.strip == COMMAND_TO_APPEND
+          return false
+        end
+      end
+
+      true
+    end
+
+    def append_annoyme_command
+      File.open(@path, 'a') do |f|
+        f.puts "\n# so annoyme gets executed on startup"
+        f.puts "annoyme print"
+      end
+    end
+  end
+end

data/lib/annoyme/version.rb

@@ -0,0 +1,3 @@
+module Annoyme
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: annoyme
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Christian Paling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: 
+email:
+- christian.paling@googlemail.com
+executables:
+- annoyme
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".simplecov"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- annoyme.gemspec
+- exe/annoyme
+- lib/annoyme.rb
+- lib/annoyme/adder.rb
+- lib/annoyme/cli.rb
+- lib/annoyme/error/config_file_does_not_exist_error.rb
+- lib/annoyme/error/shell_not_supported_error.rb
+- lib/annoyme/initializer.rb
+- lib/annoyme/logger.rb
+- lib/annoyme/notes_file.rb
+- lib/annoyme/printer.rb
+- lib/annoyme/remover.rb
+- lib/annoyme/shell_file_appender.rb
+- lib/annoyme/version.rb
+homepage: https://github.com/bakku/annoyme
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: helpfully annoys you on your command line
+test_files: []