diane 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98fcb7ec286e01666ff8367b214104fed956bba09deda226f66910bfe6749ba2
-  data.tar.gz: 37fd5c4cf665cb094a8536fe8b8703b9228b07fca61265c804cd3f54dfc19c01
+  metadata.gz: a498134b66cff3720bf6a9ed4ae8008f614d1c53dd31cf7f817ddf8c9f2c1620
+  data.tar.gz: 7cc6fb3d5c528603b62aeaa9f5a3de09f4f375b2a80ed3071b2063b69ced3f38
 SHA512:
-  metadata.gz: 58194d040d9fa9ab90bd5806aa86547640956842b59849465b30bda25264981c8aacf10d85a1cab648599f231b40cb5be97f0a93235915231161ac6661932146
-  data.tar.gz: 69bdc8c0eaef3ef0ec0bb8672f0fe95233735a4a44759187210b9b6899b2242410ef629c56347e988c828d5101065bb403b89ca0a6646aba4e830cae91b84b3a
+  metadata.gz: 99f447ec106a71c7223201c7d712d7cb28c596a9bee7b9c9491efab50960715ff3ff708f4305e1f51d176a79920d0d613a0717f6835edf9f91eacc0bbc55535b
+  data.tar.gz: 39ccea1b9bd4acf12b039ca9a105f6568912ae7dc3d907f5fecd72df9caac9a02ec34403f45c8771f04d6be50a5b911994b7438aeb5af042b403998a27bcc949

data/.gitignore

@@ -7,4 +7,5 @@
 /spec/reports/
 /tmp/
 Gemfile.lock
-./DIANE
+*.gem
+/DIANE

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  Exclude:
+    - 'spec/**'
+Metrics/MethodLength:
+  Max: 12
+Metrics/BlockLength:
+  Exclude:
+    - 'bin/**'

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+env:
+  global:
+    - CC_TEST_REPORTER_ID=f771d5ac414479894286db3ea5f2f2ae8f90fb301593b37a5df1ac358d61d2a9
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rubocop
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -1,4 +1,4 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in diane.gemspec
+source 'https://rubygems.org'
 gemspec
+
+gem 'simplecov', require: false

data/README.md

@@ -1,12 +1,23 @@
 # Diane
+[![Gem Version](https://badge.fury.io/rb/diane.svg)](https://badge.fury.io/rb/diane) ![license](https://img.shields.io/github/license/mnyrop/diane.svg) ![GitHub top language](https://img.shields.io/github/languages/top/mnyrop/diane.svg)
 
-> *I have been assigned a secretary. Her name is Diane. She seems an interesting cross between a saint and a cabaret singer.*
+[![Build Status](https://travis-ci.org/mnyrop/diane.svg?branch=master)](https://travis-ci.org/mnyrop/diane) [![Maintainability](https://api.codeclimate.com/v1/badges/0e84a1657af9d2258136/maintainability)](https://codeclimate.com/github/mnyrop/diane/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/0e84a1657af9d2258136/test_coverage)](https://codeclimate.com/github/mnyrop/diane/test_coverage) ![Libraries.io](https://img.shields.io/librariesio/github/mnyrop/diane.svg)
 
-A tiny + salty Ruby CL utility for recording and playing back your thoughts/intel/motivations, without bloating the Git logs.
+
+
+
+### A Ruby CL documentation utility for recording and playing back your thoughts/intel/motivations, without bloating the Git logs. ☕️
+
+<br>
+
+> *I have been assigned a secretary. Her name is Diane.*<br>
+> *She seems an interesting cross between a saint and a cabaret singer.*
+
+<br>
 
 <img src="https://media.giphy.com/media/WubJTtnWXKfmM/giphy.gif" width="400"/>
 
-![diane screen gif](./docs/diane.gif)
+<br>
 
 ## Installation
 
@@ -24,9 +35,82 @@ Or install it yourself as:
 
     $ gem install diane
 
+<br>
+
 ## Usage
+<br>
+
+![diane screen gif](./diane.gif)
+
+<br>
+
+Diane has two subcommands: [`record`](#record) and [`playback`](#playback):
+
+
+### Record
+
+
+#### Usage:
+```sh
+diane record MESSAGE
+```
+
+#### Example:
+```sh
+diane record "I'm in the middle of adding git-lfs. Remind me to return + test."
+```
+
+#### Options:
+
+- `--user USER` : By default, Diane records the message and attributes it to the git user currently logged in. To override this, use the `--user` option:
+
+    ```sh
+    diane record "the owls are not what they seem" --user "the_giant"
+    ```
+
+### Playback
+
+#### Usage:
+```sh
+diane playback NUMBER
+```
+
+#### Example:
+```sh
+diane playback 3
+```
+
+#### Options:
+
+- `--all` : By default, Diane plays back 1 recording or the `NUMBER` specified. To override this, use the `--all` option to return every recording that matches the query.
+
+    ```sh
+    diane playback --all
+    ```
+
+- `--user USER` : By default, Diane plays back the recording(s) attributed to the git user currently logged in. To override this, use the `--user` option:
+
+    ```sh
+    diane playback 3 --user "bob"
+    ```
+- `--everyone` : If you want to return a `NUMBER` of recordings irrespective of user, use the `--everyone` option.
+
+    ```sh
+    diane playback --all --everyone
+    ```
+- `--inorder` : By default, diane plays back the most recent recordings first. You can override this and reverse them with the option `--inorder`.
+
+    ```sh
+    diane playback 5 --inorder
+    ```
+<br>
+
+> __Note:__ By default, `diane playback` with no number or options returns the single most recent result by the logged in user.
+
+<br>
 
-TODO: Write usage instructions here
+For more, see Diane's [Yardoc](https://www.rubydoc.info/github/mnyrop/diane/master/Diane).
 
+<hr>
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/console

@@ -1,14 +1,14 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "diane"
+require 'bundler/setup'
+require 'diane'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
+# require 'pry'
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/diane

@@ -5,29 +5,32 @@ require 'diane'
 
 Mercenary.program(:diane) do |p|
   p.version Diane::VERSION
-  p.description ''
-  p.syntax "diane <subcommand> [options]"
+  p.description %(CL gem for recording and playing back thoughts/
+    intel/ motivations without bloating the Git logs.)
+  p.syntax 'diane <subcommand> [options]'
 
   p.command(:record) do |c|
     c.syntax 'record MESSAGE'
-    c.description ''
-    c.option 'user', '--user', 'Override'
-    c.action do |args, opts|
-      message = args.first
-      Diane::Recorder.new(message, opts)
-    end
+    c.description 'Record a new message with/to Diane'
+    c.option :user, '--user USER', %(Set user manually,
+      instead of fetching from git config (default))
+    c.action { |args, opts| Diane::Recorder.new(args.first, opts).record }
   end
 
   p.command(:playback) do |c|
     c.syntax 'playback NUMBER'
-    c.description ''
-    c.option 'all', '--all', 'Playback all matching recordings (no int limit)'
-    c.option 'inorder', '--inorder', 'Playback oldest recordings first'
-    c.option 'everyone', '--everyone', 'Playback everyone\'s recording, not just your own'
+    c.description %(Playback existing recordings by querying Diane)
+    c.option :all, '--all', %(Playback all matching recordings,
+      instead of 1 (default) or a specified NUMBER)
+    c.option :inorder, '--inorder', %(Playback oldest recordings first,
+      instead of most recent (default))
+    c.option :user, '--user USER', %(Playback a specific user/all
+      recordings, instead of your own (default))
+    c.option :everyone, '--everyone', %(Playback a recordings regardless
+      of user, instead of your own (default))
     c.action do |args, opts|
-      num = args.first.to_i.abs
-      num += 1 if num == 0
-      Diane::Player.new(num, opts)
+      opts['num'] = args.first.to_i.abs
+      Diane::Player.new(opts).play
     end
   end
 end

data/diane.gemspec

@@ -1,26 +1,28 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "diane/version"
+$LOAD_PATH.push File.expand_path('lib')
 
 Gem::Specification.new do |spec|
-  spec.name          = "diane"
-  spec.version       = Diane::VERSION
-  spec.authors       = ["mnyrop"]
-  spec.email         = ["m.nyrop@columbia.edu"]
+  spec.name          = 'diane'
+  spec.version       = '0.0.2'
+  spec.authors       = ['mnyrop']
+  spec.email         = ['m.nyrop@columbia.edu']
 
-  spec.summary       = %q{CL gem for recording and playing back thoughts/intel/motivations without bloating the Git logs.}
-  spec.description   = %q{I have been assigned a secretary. Her name is Diane. She seems an interesting cross between a saint and a cabaret singer.}
-  spec.homepage      = "https://github.com/mnyrop/diane"
-  spec.license       = "MIT"
+  spec.summary       = %(CL gem for recording and playing back thoughts.)
+  spec.description   = %(CL gem for recording and playing back thoughts/
+    intel/ motivations without bloating the Git logs.)
+  spec.homepage      = 'https://github.com/mnyrop/diane'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.executables   = ["diane"]
-  spec.require_paths = ["lib"]
 
-  spec.add_dependency "mercenary", "~> 0.3"
-  spec.add_dependency "colorize", "~> 0.3"
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.executables   = ['diane']
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'colorize', '~> 0.8'
+  spec.add_dependency 'mercenary', '~> 0.3'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'faker', '~> 1'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rubocop', '>= 0.5'
 end

data/lib/diane.rb

@@ -1,11 +1,9 @@
-require 'date'
-
-require 'diane/version'
 require 'diane/player'
 require 'diane/recorder'
 
+# Umbrella module for Diane player/recorder
 module Diane
-  DIFILE  = './DIANE'
-  USER    = `git config user.name`.strip
-  TIME    = DateTime.now.strftime("%d/%m/%Y %H:%M")
+  DIFILE  = "#{`pwd`.strip}/DIANE".freeze # Location of Diane file
+  USER    = `git config user.name`.strip # Git user initiating the recording
+  VERSION = '0.0.2'.freeze # Gem version
 end

data/lib/diane/player.rb

@@ -2,46 +2,65 @@ require 'csv'
 require 'colorize'
 
 module Diane
+  # Reconstructs and plays back recordings
   class Player
-    def initialize(num, opts)
-      @num = num
-      @inorder = opts.fetch('inorder', false)
-      @everyone = opts.fetch('everyone', false)
-      @all = opts.fetch('all', false)
-      @recordings = recordings
+    attr_reader :recordings, :user
 
-      play
+    def initialize(opts)
+      @num        = opts.fetch(:num, 1)
+      @inorder    = opts.fetch(:inorder, false)
+      @user       = opts.fetch(:user, USER)
+      @everyone   = opts.fetch(:everyone, false)
+      @all        = opts.fetch(:all, false)
+      @recordings = query(all_recordings)
     end
 
-    def recordings
-      r = CSV.read(DIFILE, { headers: true }).map(&:to_hash)
-      r.select!{ |d| d['user'] == USER } unless @everyone
-      limit = @all ? r.length : [@num, r.length].min
-      r.reverse! unless @inorder
-      r.take(limit)
+    # Returns hash array of all
+    # recordings in DIANE file
+    def all_recordings
+      opts = {
+        headers: true,
+        header_converters: :symbol,
+        encoding: 'utf-8'
+      }
+      CSV.read(DIFILE, opts).map(&:to_hash)
     end
 
+    # Generates a subset of recordings
+    # using command options (number, user, order)
+    def query(recordings)
+      @num += 1 if @num.zero?
+      recordings.select! { |r| r[:user] == @user } unless @everyone
+      limit = @all ? recordings.length : [@num, recordings.length].min
+      recordings.reverse! unless @inorder
+      recordings.take(limit)
+    end
+
+    # generates shell message describing
+    # the recordings returned by query
     def preface
       position  = @inorder ? 'first' : 'last'
-      scope     = @everyone ? "everyone's" : 'your'
-      if @recordings.length == 1
-        preface = "\nHere's the #{position} of #{scope} recordings:"
-      else
-        preface = "\nHere's the #{position} #{@recordings.length} of #{scope} recordings:"
-      end
+      scope     = @user == USER ? 'your' : "#{@user}'s"
+      preface = if @recordings.length == 1
+                  %(Here's the #{position} of #{scope} recordings:\n)
+                else
+                  %(Here's the #{position} #{@recordings.length}
+                    of #{scope} recordings:\n)
+                end
       preface.green
     end
 
+    # returns and puts formatted recordings
+    # returned by query
     def play
-      if @recordings.empty?
-        puts "\nFuck off.".magenta
-      else
-        puts preface
-        recordings.each do |r|
-          puts "\n#{r['time']} : ".cyan + "@#{r['user']}".yellow
-          puts "#{r['message']}"
-        end
+      abort %(None from #{@user}. Fuck off.).magenta if @recordings.empty?
+      stdout = preface
+      @recordings.each do |r|
+        stdout += "\n#{r[:time]} : ".cyan + "@#{r[:user]}".yellow
+        stdout += "\n#{r[:message]}\n\n"
       end
+      puts stdout
+      stdout
     end
   end
 end

data/lib/diane/recorder.rb

@@ -1,28 +1,38 @@
+require 'csv'
 
 module Diane
+  # Records messages and metadata
   class Recorder
+    attr_reader :user
+
     def initialize(message, opts)
-      @message  = escape(message)
-      record
+      abort 'Message is Nil. Fuck off.'.magenta if message.nil?
+      @message  = message
+      @user     = slug(opts.fetch(:user, USER))
+      @time     = Time.now.asctime
     end
 
+    # generates new recording as csv row
+    # to new or existing DIANE file
     def record
       if File.exist? DIFILE
-        File.open(DIFILE, 'a') { |f| f.puts("#{USER},#{@message},#{TIME}") }
+        CSV.open(DIFILE, 'a') { |csv| csv << [@user, @message, @time] }
       else
-        File.open(DIFILE, 'a') do |f|
-          f.puts('user,message,time')
-          f.puts("#{USER},#{@message},#{TIME}")
+        CSV.open(DIFILE, 'a') do |csv|
+          csv << %w[user message time]
+          csv << [@user, @message, @time]
         end
       end
-      puts "✓".green
-    rescue => e
-      abort "Broken".magenta + "#{e}"
+      puts '✓'.green
+    rescue StandardError => e
+      abort 'Broken'.magenta + e
     end
 
-    def escape(s)
-      abort "Message is Nil. Fuck off.".magenta if s.nil?
-      "\"#{s.gsub('"','\\"')}\""
+    # normalizes and slugifies
+    # recording user handle
+    def slug(user)
+      abort 'User is nil. Fuck off.'.magenta if user.nil?
+      user.downcase.strip.tr(' ', '_').gsub(/[^\w-]/, '')
     end
   end
 end

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: diane
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - mnyrop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-01 00:00:00.000000000 Z
+date: 2018-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: mercenary
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: mercenary
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -52,8 +52,51 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
-description: I have been assigned a secretary. Her name is Diane. She seems an interesting
-  cross between a saint and a cabaret singer.
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: |-
+  CL gem for recording and playing back thoughts/
+      intel/ motivations without bloating the Git logs.
 email:
 - m.nyrop@columbia.edu
 executables:
@@ -62,7 +105,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- DIANE
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -70,12 +115,10 @@ files:
 - bin/diane
 - bin/setup
 - diane.gemspec
-- docs/DIANE
-- docs/diane.gif
+- diane.gif
 - lib/diane.rb
 - lib/diane/player.rb
 - lib/diane/recorder.rb
-- lib/diane/version.rb
 homepage: https://github.com/mnyrop/diane
 licenses:
 - MIT
@@ -99,6 +142,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: CL gem for recording and playing back thoughts/intel/motivations without
-  bloating the Git logs.
+summary: CL gem for recording and playing back thoughts.
 test_files: []

data/DIANE

@@ -1,3 +0,0 @@
-user,message,time
-mnyrop,"test",01/06/2018 17:12
-mnyrop,"test",01/06/2018 17:30

data/docs/DIANE

@@ -1,11 +0,0 @@
-user,message,time
-cooper,"entering the town of twin peaks, five miles south of the canadian border, twelve miles west of the state line",01/06/2018 15:02
-cooper,"i've never seen so many trees in my life",01/06/2018 15:02
-cooper,"i almost forgot, i've got to find out what kind of trees these are. they're really something.",01/06/2018 15:03
-cooper,"the owls are not what they seem",01/06/2018 15:03
-cooper,"I have no idea where this will lead us. But I have a definite feeling it will be a place both wonderful and strange.",01/06/2018 16:46
-cooper,"MAY A SMILE BE YOUR UMBRELLA. WE'VE ALL HAD OUR SOCKS TOSSED AROUND.",01/06/2018 16:46
-cooper,"Pie. Whoever invented the pie? Here was a great person.",01/06/2018 16:48
-cooper,"I believe I was visited by a giant last night. Twice.",01/06/2018 16:53
-mnyrop,"when you see me again, it won't be me",01/06/2018 16:58
-mnyrop,"one day my log will have something to say about this",01/06/2018 17:04

data/lib/diane/version.rb

@@ -1,3 +0,0 @@
-module Diane
-  VERSION = "0.0.1"
-end