liste 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 297f94ef59a72cd7baed74d73965cc2a0679d3ec
-  data.tar.gz: 007c79e886df519ec69ae74bdf105a9ea1cad382
+  metadata.gz: 3ca007b32ac7ec61eb742b2a184ad711f2a8b76d
+  data.tar.gz: 79db07ae0f9b180e9813869d2ebfb2bb69d34c36
 SHA512:
-  metadata.gz: dc48bca90cd02443d58d700f60d8c1ed0d72d0e43c25a28c0f82f840b6534009b8febb7ead12f7450b08738bc298ad8f842b2e6fe99e3c0173a2897f707bb896
-  data.tar.gz: d768da6d52e7bed5a5dc95d3df5a8e52fc2cf4644ae0e90acd9b8202415666fb5e43e969b26c4570d35841326febe446caf6fa1ffacc6da83192aee1926e8d16
+  metadata.gz: 54b5248dd3a276736823ae5a75f4c30ed73674b63eeda1441969d625ba3c6b426ee015ebbb875ace6bb5200f0bba6a2c58dfc94dad75512ce63e6ceb61006744
+  data.tar.gz: dc483c460f7236c30b03030a2ae0c6a24d4e2bc06697cac24dca049ad4207a74d409f26c10fa79afa364432698bbc01e592f6744cfceaee10389fd19fdd260e4

data/README.md

@@ -8,30 +8,55 @@ for your own system of notes and reminders.
 
 ## Installation
 
-It doesn't get that much harder than this:
+It doesn't get that much easier than this:
 
-+ `sudo gem install liste`
-+ `printf "\nliste login" >> ~/.bashrc`
++ `sudo gem install liste` Download & install via RubyGems
++ `printf "\nliste login" >> ~/.bashrc` If you want the custom login messages option
++ `liste` Do this on first run to initialize the list file
 
 ## Usage
 
 Liste is not hard to use either, running `liste` by itself will 
-display your todo list. `liste do "Anything I need to do"` adds 
-to your todo list. Add to your terminal login messages list with 
-`liste add login "CTRL + D logs you out of bash automatically"`.
+display your todo list.
 
-Copied straight from `liste help`:
+### Add to your todo list
+`liste "Any content goes here"` 
 
-do task            :  add 'task' to the todo list
-add list task      :  add 'task' to 'list'
-disp list          :  display content of 'list'
-login              :  show your login list
-mark list done 1   :  remove line 1 from list
-edit list          :  open list in editor
-rmi                :  interactively remove lists
-rm list1 list2 etc :  remove lists list1, list2, etc
+Pretty simple huh? That will add "Any content goes here" to your todo list.
 
-### Contribute
+Important: *Be sure to have some sort of whitespace in the content, or it will not be added correctly.*
+
+### Have custom login messages
+Add to your terminal login messages list with:
+
+`liste .login "My login reminder"`
+
+As soon as you login (open a new terminal window), you will see this :
+
+```
+Your tasks...
+
+ • My login reminder
+
+you@host:~$ 
+```
+
+### Create and add to any other list
+If you think that a 'login' and 'todo' list isn't enough, you can make a new list:
+
+`liste .anylistname "Content to add to your custom list"`
+
+To view this new list (this is sort of important), you can use `disp` like so:
+
+`liste .anylistname disp`
+
+Note: Although it's possible to have spaces in your list name (`liste ".spaces in this list name" "This list has spaces"`), 
+you would have to put quotes around the name, so it's clumsy and not recommended.
+
+### Other usage help
+Run `liste help` for more complete usage instructions.
+
+## Contribute
 
 The feature you want isn't going to come out of nowhere
 
@@ -41,5 +66,5 @@ The feature you want isn't going to come out of nowhere
 4. Push to the branch `git push origin my-new-feature`
 5. Create a new Pull Request on github
 
-+ [Daniel Ethridge](https://github.com/wlib) - author
-+ [You](https://yourwebsite.com) - helped add...
++ [Daniel Ethridge](https://wlib.github.io) - author
++ [You](https://yourwebsite.com) - helped add...

data/bin/liste

@@ -2,67 +2,34 @@
 # Liste - reminders, notes, ideas on the go
 # Daniel Ethridge
 
-require 'fileutils'
+require "liste"
+include Liste
 
-args = ARGV.map(&:downcase)
+# 'argv' will be the lowercase version of 'ARGV', this helps for argument matching
+argv = ARGV.map(&:downcase)
 
-# Creates a new list
-def init(list)
-  unless File.directory?("#{Dir.home}/.liste")
-    FileUtils.mkdir_p("#{Dir.home}/.liste")
-  end
-  File.open("#{Dir.home}/.liste/#{list}.list", "w")
-  puts "New list created in '#{Dir.home}/.liste/#{list}.list'\n"
-end
+help = "\nUsage : `liste` or `liste [arguments]` or 
+`liste .listname \"task\"` or `liste .listname [arguments]`
 
-# Pretty-prints a list's contents
-def disp(listname, style)
-  list = File.open("#{Dir.home}/.liste/#{listname}.list", "r") rescue init(listname)
-  case style
-    when "bullet"
-      bullet = "\u2022"
-      File.foreach(list) do |line|
-        puts " #{bullet} #{line}"
-      end
-    when "check"
-      check = "\u2714"
-      File.foreach(list) do |line|
-        puts " #{check} #{line}"
-      end
-    when "number"
-      File.foreach(list).with_index do |line, i|
-        puts "#{i+1}. #{line}"
-      end
-  end
-  print "\n"
-end
+Liste is for those who have short-term memory and
+those who need constant reminders.
+You should add the line 'liste login' to your .bashrc
 
-# Shortcut the manually edit a list
-def edit_list(list = "todo")
-  system "editor #{Dir.home}/.liste/#{list}.list" rescue edit_list()
-end
+When adding an item to a list, the content MUST contain whitespace to be
+selected, this is accomplished by adding quotes around your list item :
+`liste .list \"my content has whitespace\"` This is done to prevent the shell
+from splitting your content into seperate arguments.
 
-# Simple interactive list remover
-def rmi()
-  puts "Type which of these lists to remove, type `exit` when done\n\n"
-  dir = Dir["#{Dir.home}/.liste/*.list"].join("\n") rescue exit
-  puts dir.scan(/(?<=\.liste\/)(.*?)(?=\.list)/)
-  print "\nremove> "
-  input = $stdin.gets.chomp
-  if input == "exit"; exit; end
-  FileUtils.rm_r("#{Dir.home}/.liste/#{input}.list") rescue rmi()
-  puts "List '#{input}' removed"
-end
+--------------------------------------------------
 
-# Removes an array of lists
-def rm_lists(lists)
-  i = 0
-  while i < lists.length
-    FileUtils.rm_r("#{Dir.home}/.liste/#{lists[i]}.list") rescue rmi()
-    i += 1
-  end
-  puts "List(s) '#{lists.join(', ')}' removed"
-end
+\"task to do\"            :  add 'task' to the todo list
+.login \"task to do\"     :  add 'task' to the login list
+.anylist disp           :  display the contents of 'anylist'
+
+--------------------------------------------------
+
+If you find a bug, want extra features, or have a suggestion,
+make a branch on github : https://github.com/wlib/liste\n\n"
 
 # Just running `liste` (no arguments) will display content of the "todo" list
 if ARGV.empty?
@@ -72,79 +39,49 @@ if ARGV.empty?
   exit
 end
 
-# Defines how the arguments are interpretted
-case args[0]
+case argv[0]
   when "?", "h", "help", "-h", "--help"
-    puts "\nUsage : `liste` or `liste [arguments]`\n\n\
-    Liste is for those who have short-term memory and\n\
-    those who need constant reminders.\n\
-    You should add the line 'liste login' to your .bashrc\n\n\
-    do task            :  add 'task' to the todo list\n\
-    add list task      :  add 'task' to 'list'\n\
-    disp list          :  display content of 'list'\n\
-    login              :  show your login list\n\
-    mark list done 1   :  remove line 1 from list\n\
-    edit list          :  open list in editor\n\
-    rmi                :  interactively remove lists\n\
-    rm list1 list2 etc :  remove lists list1, list2, etc\n\n\
-    If you find a bug, want extra features, or have a suggestion, make a branch\n\
-    on github : https://github.com/wlib/liste\n\n"
-  # `liste do "my task"` adds "my task" to the "todo" list
-  when "do"
-    todo = File.open("#{Dir.home}/.liste/todo.list", "a") rescue
-      init("todo"); todo = File.open("#{Dir.home}/.liste/todo.list", "a")
-    todo << "#{ARGV[1..-1].join(' ')}\n"
-    exit
-  # `liste add login "my reminder"` adds a line to the list "login"
-  when "add"
-    list = File.open("#{Dir.home}/.liste/#{ARGV[1]}.list", "a") rescue
-      init("#{ARGV[1]}"); list = File.open("#{Dir.home}/.liste/#{ARGV[1]}.list", "a")
-    list << "#{ARGV[2..-1].join(' ')}\n"
-    exit
-  # Displays the content in any list
-  when "disp"
-    puts "Your list '#{ARGV[1]}'...\n\n"
-    disp("#{ARGV[1]}", "bullet") rescue
-      puts "...nothing here yet"; exit
+    puts help
     exit
   # This displays the "login" list
   when "login"
     puts "Your tasks...\n\n"
     disp("login", "bullet") rescue
-      puts "...nothing here yet"; exit
+      puts "\n...nothing here yet"; exit
     exit
-  # Marks a list or line in a list a certain way...
-  when "mark"
-    case args[2]
-      # Marks a line as done, removes from that list, adds to the "done" list
-      when "done"
-        listfile = File.open("#{Dir.home}/.liste/#{args[1]}.list", "r+") rescue exit
-        todo = listfile.readlines
-        listfile.close
-        done = File.open("#{Dir.home}/.liste/done.list", "a") rescue
-          done_init(); done = File.open("#{Dir.home}/.liste/done.list", "a")
-        line_index = args[3].to_i - 1
-        if line_index >= todo.length; puts "check line number"; exit end
-        done.puts todo[line_index]
-        todo.delete_at(line_index)
-        listfile = File.open("#{Dir.home}/.liste/#{args[1]}.list", "w")
-        listfile.puts todo
-        exit
-      else
-        puts "not sure what to mark... did you mean `liste mark [list] done [line #]`"
-    end
   # Calls the edit shortcut
   when "edit"
-    edit_list(ARGV[1])
+    edit_list()
     exit
-  # Calls interactive list deletion
-  when "rmi"
-    rmi()
-  # Calls deletion of one or more lists
-  when "rm"
-    if args.length < 2; puts "did you mean `liste rmi` for interactive list removal?"; exit end
-    rm_lists(ARGV[1..-1])
+end
+
+# Parse shell input in the format `liste .listname ["content" / arguments]`
+if argv[0].start_with?('.')
+  listname = ARGV[0][1..-1]
+end
+content = ARGV.select{ |e| e[/\s/] }.join(' ')
+args = ARGV[1..-1].select{ |e| ! e[/\s/] }.map(&:downcase)
+
+# Add content to the todo list, alternatively add to any other list
+unless content.empty?
+  if ! listname.nil?
+    add(listname, content) rescue newlist(listname, content)
+    exit
+  elsif listname.nil?
+    add("todo", content) rescue newlist("todo", content)
+    exit
+  end
+end
+
+# More than one list argument can be run at a time
+case
+  # Displays the content in any list
+  when args.include?("disp")
+    puts "Your list '#{listname}'...\n\n"
+    disp("#{listname}", "bullet") rescue
+      puts "\n...nothing here yet"; exit      
     exit
-  else
-    puts "Your first argument was not valid"
-end
+end
+
+# If nothing is caught then throw an error message
+puts "Something went wrong, I'm not sure what you want me to do"; exit

data/lib/liste.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+# Functions used in liste
+# Daniel Ethridge
+
+module Liste
+  # Creates a new list
+  def init()
+    unless File.directory?("#{Dir.home}/.liste")
+      require 'fileutils'
+      FileUtils.mkdir_p("#{Dir.home}/.liste")
+    end
+    File.open("#{Dir.home}/.liste/main.list", "w")
+    puts "New list created in '#{Dir.home}/.liste/main.list'\n\n"
+  end
+
+  def newlistfile(listname, content, path)
+  	hash = { :"#{listname}" => {:l0 => content} }
+    json = JSON.pretty_generate(hash)
+    file = File.open("#{path}", 'w')
+    file.puts json
+    file.close
+    puts "new list '#{listname}' created"
+  end
+
+  def newlist(listname, content="This is a placeholder", path="#{Dir.home}/.liste/main.list")
+    require 'json'
+    file = File.open("#{path}", 'r')
+    listfile = file.read
+    file.close
+    if listfile.nil? || listfile.empty?; newlistfile(listname, content, path); exit end
+    listhash = { :"#{listname}" => {:l0 => content } }
+    hash = JSON.parse(listfile)
+    newhash = hash.merge!(listhash)
+    json = JSON.pretty_generate(newhash)
+    file = File.open("#{path}", 'w')
+    file.puts json
+    file.close
+  end
+
+  # Make a list item and add to the json list file
+  def add(listname, content, path="#{Dir.home}/.liste/main.list")
+    require 'json'
+    file = File.open("#{path}", 'r')
+    listfile = file.read
+    file.close
+    listhash = JSON.parse(listfile)
+    if ! listhash.keys.include? listname; newlist(listname) end
+    listcontent = listhash[listname]
+    i = 0
+    while listcontent.keys.include? "l#{i}"
+      i += 1
+    end
+    newcontent = { "l#{i}" => content }
+    listcontent.merge!(newcontent)
+    newjson = JSON.pretty_generate(listhash)
+    file = File.open("#{path}", 'w')
+    file.puts newjson
+    file.close
+  end
+
+  def putlines(listname)
+    require 'json'
+    file = File.open("#{Dir.home}/.liste/main.list") rescue init()
+    listfile = file.read
+    listhash = JSON.parse(listfile)
+    linesout = []
+    i = 0
+    while i < listhash[listname].count
+      line = listhash[listname]["l#{i}"]
+      linesout << "#{line}"
+      i += 1
+    end
+    linesout
+  end
+
+  # Pretty-prints a list's contents
+  def disp(listname, style)
+    bullet = "\u2022"
+    check = "\u2714"
+    linesout = putlines(listname)
+    case style
+      when "bullet"
+      linesout.each do |line|
+        puts " #{bullet} #{line}"
+      end
+      when "check"
+        linesout.each do |line|
+          puts " #{check} #{line}"
+        end
+      when "number"
+        linesout.each.with_index do |line, i|
+          puts "#{i+1}. #{line}"
+        end
+    end
+    print "\n"
+  end
+
+  # Shortcut the manually edit a list
+  def edit_list()
+    system "editor #{Dir.home}/.liste/main.list" rescue edit_list()
+  end
+end

data/lib/liste/version.rb

@@ -1,3 +1,3 @@
 module Liste
-  VERSION = "1.0.0"
-end
+  VERSION = "2.0.0"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: liste
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Daniel Ethridge
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-05 00:00:00.000000000 Z
+date: 2016-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,8 @@ files:
 - Rakefile
 - bin/liste
 - bin/setup
+- gems/liste-1.0.0.gem
+- lib/liste.rb
 - lib/liste/version.rb
 - liste.gemspec
 homepage: https://github.com/wlib/liste