simple_note_parser 0.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7fcacab485cab2f6edfe6e0aa548f9f94b22b0101051f04eaa0d10b94385068
-  data.tar.gz: dac28c36c74d0f159e34cd022eb8c284dacee157d7a117b0731d39f6de6243a9
+  metadata.gz: 283d4e0a12561fbb3abd8be9f0ac7a8fe66881f323e1a1fd126e042493974410
+  data.tar.gz: f724c4b9a0acd1653df3404c9ca3733b53bbabf7f6dd36a64063173743077969
 SHA512:
-  metadata.gz: 6240465534416c46d73797dd830749865eebac51c3799908d32e324fa5aa7aae40fb3f4276176aa5a9984d608b9bccfe9183ebecb6b9283fcad3930faae255bc
-  data.tar.gz: 9d5b5eadb4a66a496662f597b148e35e105ac514e62e06e752ff839c46696c76bac034196937e981a52f7ff8b34b298904185bae61a05d9f9d06f8f9ecaf2391
+  metadata.gz: f7195682e205da44e01328b0aa89bf94f46ef87084f086fe6eaf0bd0e53bd5157e132b3b6f50fdc54c2ebb106a86717bef74231de5d89adef6f0abe62cd13c08
+  data.tar.gz: 667254781049a78e6e7389822d7154b09f0bb0f7c4621be1f43c88355a839c0c7e579ae547aedfcb50a4d37c689b759beb63999cc0f1df457856b8e3f6906104

data/.gitignore

@@ -6,3 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+.DS_Store
+test/tmp/
+.byebug_history

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/Gemfile

@@ -5,3 +5,4 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"
+gem "byebug", "~> 11.1", ">= 11.1.3"

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    simple_note_parser (0.1.2)
+    simple_note_parser (2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    byebug (11.1.3)
     minitest (5.14.0)
     rake (12.3.2)
 
@@ -13,6 +14,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  byebug (~> 11.1, >= 11.1.3)
   minitest (~> 5.0)
   rake (~> 12.0)
   simple_note_parser!

data/README.md

@@ -1,6 +1,9 @@
 # SimpleNoteParser
 
-Organizes exported [Simplenote](https://app.simplenote.com/) data into directories based on the note's tag.
+Organizes and parse exported [Simplenote](https://app.simplenote.com/) data.
+
+- Organize notes into directories based on the note's tag.
+- Merge notes into a `csv` file.
 
 ## Installation
 
@@ -23,27 +26,61 @@ Or install it yourself as:
 1. Export data from [Simplenote](https://simplenote.com/help/#export).
 1. Unzip the file.
 1. Open a new terminal window and change directories by navigating into the unzipped directory.
-1. Run `gem install simple_note_parser`
-1. Run `irb` to start a new Ruby session. Once the prompt starts, run the following:
+1. Run `gem install simple_note_parser`.
+1. Run `irb` to start a new Ruby session. Once the prompt starts, run `require "simple_note_parser"`.
 
-```console
-> require "simple_note_parser"
-=> true
-> @notes = SimpleNoteParser.new
-=> #<SimpleNoteParser:0x00007fef45892768 @file="./source/notes.json", @destination="./organized-by-tag">
-> @notes.import
-=> ...
+Once you complete these steps, you can use `SimpleNoteParser::Organizer` or organize notes, or `SimpleNoteParser::Processor` to create a `csv` from the notes.
+
+### SimpleNoteParser::Organizer
+
+Organizes notes into directories based on the note's tag.
+
+```ruby
+SimpleNoteParser::Organizer.new(file: "./source/notes.json", destination: "./dist/organized-by-tags")
 ```
 
+- Requires a `file` value. This is the `JSON` file exported by SimpleNote.
+  - Defaults to `./source/notes.json`.
+- Requires a `destination` value. This is where the directories will be created.
+  - Defaults to `./dist/organized-by-tags`.
+
+#### Usage
+
 This will create a directory called `organized-by-tag` in the current directory which will contain additional directories based on each note's tag.
 
-1. Optionally run `@notes.clean` to recursively remove the `organized-by-tag` directory.
+```console
+> @notes = SimpleNoteParser::Organizer.new
+> @notes.organize_by_tag
+```
+
+Optionally run `@notes.clean` to recursively remove the `organized-by-tag` directory.
+
+### SimpleNoteParser::Processor
+
+Merge notes into a `csv` file.
+
+```ruby
+SimpleNoteParser::Processor.new(file: "./source/notes.json", destination: "./dist", headers: %w[title content tags])
+```
+
+- Requires a `file` value. This is the `JSON` file exported by SimpleNote.
+  - Defaults to `./source/notes.json`.
+- Requires a `destination` value. This is where the `csv` will be created.
+  - Defaults to `./dist`.
+- Requires a `headers` value. This will be used as the header row in the `csv`.
+  - Defaults to `["title", "content", "tags"]`.
+
+#### Usage
+
+This will create a `csv` of notes called `notes.csv` in the destination directory.
 
 ```console
-> @notes.clean
-=> ["./organized-by-tag"]
+> @notes = SimpleNoteParser::Processor.new
+> @notes.save_as_csv
 ```
 
+Optionally run `@notes.clean` to remove the destination directory and `csv`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/simple_note_parser.rb

@@ -1,60 +1,3 @@
 require "simple_note_parser/version"
-require "json"
-require "fileutils"
-class SimpleNoteParser
-  attr_accessor :file, :destination
-
-  def initialize(file = "./source/notes.json", destination = "./organized-by-tag")
-    @file = file
-    @destination = destination
-  end
-
-  def clean
-    FileUtils.rm_rf(destination)
-  end
-
-  def import
-    json_data = load_json_data(file)
-    notes = parse_json_data(json_data)
-    process_notes(notes)
-  end
-
-  private
-
-  def load_json_data(path)
-    file = File.open path
-    json_data = JSON.load file
-  end
-
-  def parse_json_data(json_data)
-    notes = json_data["activeNotes"]
-  end
-
-  def process_notes(notes)
-    notes.each do |note|
-      tags = note["tags"]
-      if tags.nil? || tags.empty?
-        path = "#{destination}/no-tags"
-        create_directory(path)
-        create_file(path, note)
-      else
-        tags.each do |tag|
-          path = "#{destination}/#{tag.downcase}"
-          create_directory(path)
-          create_file(path, note)
-        end
-      end
-    end
-  end
-
-  def create_directory(path)
-    FileUtils.mkdir_p(path) unless Dir.exist?(path)
-  end
-
-  def create_file(path, note)
-    first_line = note["content"].split("\r").first
-    name = first_line.downcase.strip.tr(" ", "-").gsub(/[^\w-]/, "")
-    content = note["content"]
-    File.open("#{path}/#{name}.txt", "w") { |f| f.write content }
-  end
-end
+require "simple_note_parser/organizer"
+require "simple_note_parser/processor"

data/lib/simple_note_parser/base.rb

@@ -0,0 +1,31 @@
+require "json"
+require "fileutils"
+module SimpleNoteParser
+  class Base
+    attr_accessor :file, :destination
+
+    def initialize(file: "./source/notes.json", destination: "./dist")
+      @file = file
+      @destination = destination
+    end
+
+    def clean
+      FileUtils.rm_rf(destination)
+    end
+
+    private
+
+    def load_json_data(path)
+      file = File.open path
+      JSON.load file
+    end
+
+    def parse_json_data(json_data)
+      json_data["activeNotes"]
+    end
+
+    def create_directory(path)
+      FileUtils.mkdir_p(path) unless Dir.exist?(path)
+    end
+  end
+end

data/lib/simple_note_parser/organizer.rb

@@ -0,0 +1,43 @@
+require "simple_note_parser/base"
+module SimpleNoteParser
+  class Organizer < SimpleNoteParser::Base
+    attr_accessor :file, :destination
+
+    def initialize(file: "./source/notes.json", destination: "./dist/organized-by-tags")
+      @file = file
+      @destination = destination
+    end
+
+    def organize_by_tag
+      json_data = load_json_data(file)
+      notes = parse_json_data(json_data)
+      process_notes(notes)
+    end
+
+    private
+
+    def process_notes(notes)
+      notes.each do |note|
+        tags = note["tags"]
+        if tags.nil? || tags.empty?
+          path = "#{destination}/no-tags"
+          create_directory(path)
+          create_file(path, note)
+        else
+          tags.each do |tag|
+            path = "#{destination}/#{tag.downcase}"
+            create_directory(path)
+            create_file(path, note)
+          end
+        end
+      end
+    end
+
+    def create_file(path, note)
+      first_line = note["content"].split("\r").first
+      name = first_line.downcase.strip.tr(" ", "-").gsub(/[^\w-]/, "")
+      content = note["content"]
+      File.open("#{path}/#{name}.txt", "w") { |f| f.write content }
+    end
+  end
+end

data/lib/simple_note_parser/processor.rb

@@ -0,0 +1,50 @@
+require "simple_note_parser/base"
+require "csv"
+
+module SimpleNoteParser
+  class Processor < SimpleNoteParser::Base
+    attr_accessor :file, :destination, :headers
+
+    def initialize(file: "./source/notes.json", destination: "./dist", headers: %w[title content tags])
+      @file = file
+      @destination = destination
+      @headers = headers
+    end
+
+    def save_as_csv
+      json_data = load_json_data(file)
+      notes = parse_json_data(json_data)
+      create_directory(destination)
+      create_csv
+      process_notes(notes)
+    end
+
+    private
+
+    def csv_path
+      destination + "/notes.csv"
+    end
+
+    def process_notes(notes)
+      CSV.open(csv_path, "wb", headers: true) do |csv|
+        csv << headers
+        notes.each do |note|
+          add_row_to_csv(note, csv)
+        end
+      end
+    end
+    
+    def add_row_to_csv(note, csv)
+      title = note["content"].split("\r").first
+      content = note["content"]
+      tags = note["tags"]
+      formatted_tags = tags.join(", ") unless tags.nil?
+      csv << [title, content, formatted_tags]
+    end
+
+    def create_csv
+      CSV.new(csv_path, headers: true)
+    end
+
+  end
+end

data/lib/simple_note_parser/version.rb

@@ -1,3 +1,3 @@
-class SimpleNoteParser
-  VERSION = "0.1.2"
+module SimpleNoteParser
+  VERSION = "2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_note_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Steve Polito
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-08 00:00:00.000000000 Z
+date: 2020-05-14 00:00:00.000000000 Z
 dependencies: []
 description: Organizes exported Simplenote data into directories based on the note's
   tag.
@@ -19,6 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -28,6 +29,9 @@ files:
 - bin/console
 - bin/setup
 - lib/simple_note_parser.rb
+- lib/simple_note_parser/base.rb
+- lib/simple_note_parser/organizer.rb
+- lib/simple_note_parser/processor.rb
 - lib/simple_note_parser/version.rb
 - simple_note_parser.gemspec
 homepage: https://github.com/stevepolitodesign/simple_note_parser
@@ -52,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Parse notes from Simplenote