clippings 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 92b07bdac3414a78b7a73d38b5225c417529ce47e825b854d8c759b6ecfca1ac
+  data.tar.gz: 179599de9d35808b66527fa289f2ec6d66ea1170ef177cc862718c3be84d23c9
+SHA512:
+  metadata.gz: a6b63c6eb9c171edee0b279983dff1c5e4bda9608226a186a83058837e436393c67cb662eaf1ab7583f6f5617c12f5a5414f471372765b7220bbc5a8226c4315
+  data.tar.gz: 3d92b9383468cb90fab66c6f5f1eecdf9971bf0d0fa8d5dbd4f108d28139d3a2d1e12008dab6e81d670a2a75458a2965ca9e2380299a077960609039f3979295

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in clippings.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 badtudou
+
+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,119 @@
+# Clippings
+
+**Clippings** can parse notes and highlights in your Kindle clippings.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clippings'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clippings
+
+## Usage
+
+```ruby
+require 'clippings'
+clippings = Clippings::Parse.new("My Clippings.txt")
+notes = clippings.parseForNote
+notes.each do |title, note|
+    print title, note[:author], note[:fragment]
+end
+```
+## Example
+**test.txt**
+```
+==========
+HTTP权威指南 (图灵程序设计丛书) ([美]David Gourley Brian Totty Marjorie Sayer Sailu Reddy Aushu Aggarwal)
+- 您在位置 #425-426的标注 | 添加于 2017年6月16日星期五 下午8:21:59
+
+下报文是如何通过传输控制协议（Transmission Control Protocol，TCP）连接从一个地方搬移到另一个地方去的。
+==========
+HTTP权威指南 (图灵程序设计丛书) ([美]David Gourley Brian Totty Marjorie Sayer Sailu Reddy Aushu Aggarwal)
+- 您在位置 #802 的笔记 | 添加于 2017年6月16日星期五 下午9:02:31
+
+解析相对url 的算法
+==========
+The Well-Grounded Rubyist, Second Edition (David A. Black)
+- 您在位置 #7107-7107的标注 | 添加于 2017年9月5日星期二 上午10:13:28
+
+Ranges have begin and end methods,
+==========
+The Well-Grounded Rubyist, Second Edition (David A. Black)
+- 您在位置 #7193-7193的标注 | 添加于 2017年9月5日星期二 上午10:28:42
+
+To remove an object, use delete:
+==========
+```
+
+**Code**
+```ruby
+require 'clippings'
+clippings = Clippings::Parse.new("test.txt")
+notes = clippings.parseForNote
+p notes
+```
+
+**Output**
+```
+{
+    "HTTP权威指南 (图灵程序设计丛书)"=>
+        {
+            :title=>"HTTP权威指南 (图灵程序设计丛书)", 
+            :author=>"[美]David Gourley Brian Totty Marjorie Sayer Sailu Reddy Aushu Aggarwal", 
+            :fragment=>
+                [
+                    {
+                        :content=>"HTTP 是个应用层协议\r\n", 
+                        :type=>"标注", 
+                        :date=>" 2017年6月16日星期五 下午8:22:18"
+                    }, 
+                    {
+                        :content=>"解析相对url 的算法\r\n", 
+                        :type=>"笔记", 
+                        :date=>" 2017年6月16日星期五 下午9:02:31"
+                    }, 
+                    {   
+                        :content=>"RFC 2396 中\r\n", 
+                        :type=>"标注", 
+                        :date=>" 2017年6月16日星期五 下午9:02:31"
+                    }
+                ]
+        }, 
+    "The Well-Grounded Rubyist, Second Edition"=>
+        {
+            :title=>"The Well-Grounded Rubyist, Second Edition", 
+            :author=>"David A. Black", 
+            :fragment=>
+                [
+                    {
+                        :content=>"Ranges have begin and end methods,\r\n",
+                        :type=>"标注", 
+                        :date=>" 2017年9月5日星期二 上午10:13:28"
+                    }, 
+                    {
+                        :content=>"To remove an object, use delete:\r\n", 
+                        :type=>"标注", 
+                        :date=>" 2017年9月5日星期二 上午10:28:42"
+                    }
+                ]
+        }
+}
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/badtudou/clippings-gem.
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "clippings"
+
+# 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"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/clippings.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "clippings/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "clippings"
+  spec.version       = Clippings::VERSION
+  spec.authors       = ["badtudou"]
+  spec.email         = ["badtudou@gmail.com"]
+
+  spec.summary       = %q{Parse notes and highlights in your Kindle clippings}
+  spec.description   = %q{Parse notes and highlights in your Kindle clippings, the name of the Kindle clipper file was 'My Clippings.txt'}
+  spec.homepage      = "https://github.com/BadTudou/clippings"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/clippings.rb

@@ -0,0 +1,95 @@
+require "clippings/version"
+
+module Clippings
+    NOTE_SECTION_SEPARATOR = '=========='
+    NOTE_DEFAULT_AUTHOR = 'Unknown author'
+    NOTE_DEFAULT_DATETIME = '1970-01-01 00:00:00'
+    NOTE_LABEL = 'Note|笔记'
+    HIGHLIGHT_LABEL = 'Highlight|标注'
+    ADD_LABEL = 'Added on|添加于'
+
+    attr_accessor :filepath, :notes
+
+    # 解析
+    class Parse
+    
+        def initialize(filepath)
+            @filepath = filepath
+        end
+
+        # 解析为块
+        def parseForSection
+            sections = []
+            if File.exist?(@filepath)
+                section = ''
+                File.open(@filepath, 'r') do |file|
+                    file.each_line do |line|
+                        if line.start_with?(NOTE_SECTION_SEPARATOR)
+                            sections.push(section)
+                            section = ''
+                        else
+                            section.concat(line)
+                        end
+                    end
+                end
+            end
+            sections.delete_at(0)
+            return sections
+        end
+
+        # 解析为片段
+        def parseForFragment(sections = nil)
+            sections ||= parseForSection() 
+            fragments = []
+            sections.each do |section| 
+                fragment = {}
+                fragment[:title_author], fragment[:type_date], fragment[:content] = section.split("\r", 3)
+
+                # 提取片段的标题与作者
+                /(.*)\((.*)\).*/ =~ fragment[:title_author]
+                fragment[:title] = $1 || fragment[:title_author]
+                fragment[:author] = $2 || NOTE_DEFAULT_AUTHOR
+                fragment.delete(:title_author)
+                    
+                # 提取片段的类型与创建日期
+                /(#{NOTE_LABEL}|#{HIGHLIGHT_LABEL}).*(#{ADD_LABEL})(.*)/ =~ (fragment[:type_date])
+                fragment[:type] = $1
+                fragment[:date] = $3 || NOTE_DEFAULT_DATETIME
+                fragment.delete(:type_date)
+                
+                fragment[:content].lstrip!
+                # 将片段添加到数组
+                fragments.push(fragment)
+            end
+
+            return fragments
+        end
+
+        # 解析为笔记
+        def parseForNote(fragments = nil)
+            fragments ||= parseForFragment()
+            @notes = {}
+            fragments.each do |fragment|
+                title = fragment[:title].strip
+                author = fragment[:author]
+                fragment.delete(:title)
+                fragment.delete(:author)
+
+                if @notes.has_key?(title)
+                    @notes[title][:fragment].push(fragment)
+                else
+                    @notes[title] = {
+                                                :title=>title, 
+                                                :author=>author,
+                                                :fragment =>[fragment]
+                                    }
+                end
+            end
+
+            return @notes
+        end
+    end
+end
+
+
+

data/lib/clippings/version.rb

@@ -0,0 +1,3 @@
+module Clippings
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: clippings
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- badtudou
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: Parse notes and highlights in your Kindle clippings, the name of the
+  Kindle clipper file was 'My Clippings.txt'
+email:
+- badtudou@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clippings.gemspec
+- lib/clippings.rb
+- lib/clippings/version.rb
+homepage: https://github.com/BadTudou/clippings
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Parse notes and highlights in your Kindle clippings
+test_files: []