kcfu 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 2d27741170f7e51de397ff22d74875f8f60a1314
4
+ data.tar.gz: 838b723824ec38d8fc0841f114b730bf577df94f
5
+ SHA512:
6
+ metadata.gz: 41a09184127db7b9589a50683e623133123dbe05d6bc573636b7d852da3157f8075cbef22715c65e2f0ab6dfd7a6d2af3c1531bfe839dad2d7306f8abbc002c2
7
+ data.tar.gz: 92761267be2c2cd538f2736f626b1affd6523b95db4c8ca14913fde2cce566fe4a24ca3db1ae0fa244c18c4c878afe89da0a20d0f1a96b775a906f79c8e1ca93
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.1
5
+ before_install: gem install bundler -v 1.13.7
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at raviwu@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in kcfu.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Ravi Wu
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,61 @@
1
+ # Kcfu
2
+
3
+ Kindle `My Clippings.txt` is a simple file that aggregate the clippings by clipping time, so the book clipping is mixed into a single file.
4
+
5
+ KCFU (Kindle Clipping File Util) simply helps to parse the `My Clippings.txt` file into separated txt file with `Book Title 1.txt`, `Book Title 2.txt` based on the clippings's book title information.
6
+
7
+ The core kindle format parsing job relies on the [kindleclippings](https://github.com/georgboe/kindleclippings) project.
8
+
9
+ ## Installation
10
+
11
+ Add this line to your application's Gemfile:
12
+
13
+ ```ruby
14
+ gem 'kcfu'
15
+ ```
16
+
17
+ And then execute:
18
+
19
+ $ bundle
20
+
21
+ Or install it yourself as:
22
+
23
+ $ gem install kcfu
24
+
25
+ ## Usage
26
+
27
+ ### Separate the 'My Clippings.txt' to separated txt file according to the book title
28
+
29
+ `Kcfu::FileUtil#parse_file` will create a 'kindle_clippings' folder under PWD and separate the clippings by book_title in provided `My Clippings.txt` file.
30
+
31
+ adding `convert: :markdown` option will generate a simple markdown for the generated file
32
+
33
+ require 'kcfu'
34
+
35
+ parser = Kcfu::FileUtil.new
36
+ parser.parse_file('My Clippings.txt', convert: :markdown)
37
+
38
+ ### Simple Markdown parser to generate the clippings
39
+
40
+ `Kcfu::MdConvertor#parse_file` will create a corresponding `Book Clippings.md` according to provided `Book Clippings.txt` file.
41
+
42
+ require 'kcfu'
43
+
44
+ parser = Kcfu::MdConvertor.new
45
+ parser.parse_file('Book Clippings.txt')
46
+
47
+ ## Development
48
+
49
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
50
+
51
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
52
+
53
+ ## Contributing
54
+
55
+ Bug reports and pull requests are welcome on GitHub at https://github.com/raviwu/kcfu. 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.
56
+
57
+
58
+ ## License
59
+
60
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
61
+
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "kcfu"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,40 @@
1
+ # coding: utf-8
2
+ require 'rake'
3
+
4
+ lib = File.expand_path('../lib', __FILE__)
5
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
6
+ require 'kcfu/version'
7
+
8
+ Gem::Specification.new do |spec|
9
+ spec.name = "kcfu"
10
+ spec.version = Kcfu::VERSION
11
+ spec.authors = ["Ravi Wu"]
12
+ spec.email = ["raviwu@gmail.com"]
13
+
14
+ spec.summary = "KCFU (Kindle Clipping File Util) simply helps to parse the `My Clippings.txt` file into separated txt file with `Book Title 1.txt`, `Book Title 2.txt` based on the clippings's book title information."
15
+ spec.description = "KCFU (Kindle Clipping File Util) simply helps to parse the `My Clippings.txt` file into separated txt file with `Book Title 1.txt`, `Book Title 2.txt` based on the clippings's book title information."
16
+ spec.homepage = "https://github.com/raviwu/kcfu"
17
+ spec.license = "MIT"
18
+
19
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
20
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
21
+ if spec.respond_to?(:metadata)
22
+ spec.metadata['allowed_push_host'] = "https://rubygems.org"
23
+ else
24
+ raise "RubyGems 2.0 or newer is required to protect against " \
25
+ "public gem pushes."
26
+ end
27
+
28
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
29
+ f.match(%r{^(test|spec|features)/})
30
+ end
31
+ spec.files += FileList["lib/**/*.rb"]
32
+ spec.bindir = "exe"
33
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
34
+ spec.require_paths = ["lib"]
35
+
36
+ spec.add_development_dependency "bundler", "~> 1.13"
37
+ spec.add_development_dependency "rake", "~> 10.0"
38
+ spec.add_development_dependency "rspec", "~> 3.0"
39
+ spec.add_development_dependency "kindleclippings", "~> 1.4.0"
40
+ end
@@ -0,0 +1,3 @@
1
+ require "kcfu/version"
2
+ require "kcfu/file_util"
3
+ require "kcfu/md_convertor"
@@ -0,0 +1,71 @@
1
+ require 'kindleclippings'
2
+ require 'fileutils'
3
+
4
+ module Kcfu
5
+ class FileUtil
6
+ ROOT_CLIPPING_FOLDER_NAME = 'kindle_clippings'
7
+
8
+ def parse_file(path, options = {})
9
+ parser.parse_file(path).each do |import_clipping|
10
+ existed_clippings = parse_export_file(export_file_path(import_clipping))
11
+
12
+ next unless not_clipped_before?(existed_clippings, import_clipping)
13
+
14
+ existed_clippings << import_clipping
15
+
16
+ sorted_clippings = existed_clippings.sort { |x, y| x.added_on <=> y.added_on }
17
+
18
+ save_clipping_to_file(export_file_path(import_clipping), sorted_clippings)
19
+ end
20
+
21
+ conver_markdown(path) if options[:convert] == :markdown
22
+ end
23
+
24
+ private
25
+
26
+ def conver_markdown(path)
27
+ book_titles = parser.parse_file(path).map(&:book_title).uniq
28
+ book_titles.each { |title| markdown_converter.parse_file("#{ROOT_CLIPPING_FOLDER_NAME}/#{title}.txt") }
29
+ end
30
+
31
+ def markdown_converter
32
+ @markdown_converter = MdConvertor.new
33
+ end
34
+
35
+ def parser
36
+ @parser ||= KindleClippings::Parser.new
37
+ end
38
+
39
+ def export_file_path(clipping)
40
+ "#{ROOT_CLIPPING_FOLDER_NAME}/#{clipping.book_title}.txt"
41
+ end
42
+
43
+ def not_clipped_before?(existed_clippings, import_clipping)
44
+ existed_clippings.select do |clipping|
45
+ clipping.content == import_clipping.content && clipping.type == import_clipping.type
46
+ end.empty?
47
+ end
48
+
49
+ def seperator
50
+ "\r\n" + "=" * 10 + "\r\n"
51
+ end
52
+
53
+ def parse_export_file(path)
54
+ dir = File.dirname(path)
55
+ FileUtils.mkdir_p(dir) unless File.directory?(dir)
56
+
57
+ File.open(path, 'a')
58
+
59
+ parser.parse_file(path)
60
+ end
61
+
62
+ def save_clipping_to_file(path, clippings)
63
+ File.open(path, "w") do |f|
64
+ clippings.each do |clipping|
65
+ f.write(clipping)
66
+ f.write(seperator)
67
+ end
68
+ end
69
+ end
70
+ end
71
+ end
@@ -0,0 +1,41 @@
1
+ require 'fileutils'
2
+ require 'kindleclippings'
3
+
4
+ module Kcfu
5
+ class MdConvertor
6
+ def parse_file(path)
7
+ save_clipping_to_file(path, parser.parse_file(path))
8
+ end
9
+
10
+ private
11
+
12
+ def parser
13
+ @parser ||= KindleClippings::Parser.new
14
+ end
15
+
16
+ def location(clipping)
17
+ return "Page #{clipping.page}" if clipping.page.size > 0
18
+ return "Loc #{clipping.location}" if clipping.location.size > 0
19
+ end
20
+
21
+ def save_clipping_to_file(path, clippings)
22
+ markdown_path = path.gsub("txt", "md")
23
+
24
+ dir = File.dirname(markdown_path)
25
+ FileUtils.mkdir_p(dir) unless File.directory?(dir)
26
+
27
+ File.open(markdown_path, "w")
28
+
29
+ File.open(markdown_path, "w") do |f|
30
+ f.write("# #{clippings.first.book_title}\n\n")
31
+ f.write("by #{clippings.first.author}\n\n") if clippings.first.author
32
+ clippings.each do |clipping|
33
+ f.write("*#{clipping.type}*\n\n") unless clipping.type == :Highlight
34
+ f.write("> #{location(clipping)}\n")
35
+ f.write("> \n")
36
+ f.write("> #{clipping.content}\n\n")
37
+ end
38
+ end
39
+ end
40
+ end
41
+ end
@@ -0,0 +1,3 @@
1
+ module Kcfu
2
+ VERSION = "0.1.0"
3
+ end
metadata ADDED
@@ -0,0 +1,120 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: kcfu
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Ravi Wu
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-01-27 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.13'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.13'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: kindleclippings
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: 1.4.0
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: 1.4.0
69
+ description: KCFU (Kindle Clipping File Util) simply helps to parse the `My Clippings.txt`
70
+ file into separated txt file with `Book Title 1.txt`, `Book Title 2.txt` based on
71
+ the clippings's book title information.
72
+ email:
73
+ - raviwu@gmail.com
74
+ executables: []
75
+ extensions: []
76
+ extra_rdoc_files: []
77
+ files:
78
+ - ".gitignore"
79
+ - ".rspec"
80
+ - ".travis.yml"
81
+ - CODE_OF_CONDUCT.md
82
+ - Gemfile
83
+ - LICENSE.txt
84
+ - README.md
85
+ - Rakefile
86
+ - bin/console
87
+ - bin/setup
88
+ - kcfu.gemspec
89
+ - lib/kcfu.rb
90
+ - lib/kcfu/file_util.rb
91
+ - lib/kcfu/md_convertor.rb
92
+ - lib/kcfu/version.rb
93
+ homepage: https://github.com/raviwu/kcfu
94
+ licenses:
95
+ - MIT
96
+ metadata:
97
+ allowed_push_host: https://rubygems.org
98
+ post_install_message:
99
+ rdoc_options: []
100
+ require_paths:
101
+ - lib
102
+ required_ruby_version: !ruby/object:Gem::Requirement
103
+ requirements:
104
+ - - ">="
105
+ - !ruby/object:Gem::Version
106
+ version: '0'
107
+ required_rubygems_version: !ruby/object:Gem::Requirement
108
+ requirements:
109
+ - - ">="
110
+ - !ruby/object:Gem::Version
111
+ version: '0'
112
+ requirements: []
113
+ rubyforge_project:
114
+ rubygems_version: 2.5.1
115
+ signing_key:
116
+ specification_version: 4
117
+ summary: KCFU (Kindle Clipping File Util) simply helps to parse the `My Clippings.txt`
118
+ file into separated txt file with `Book Title 1.txt`, `Book Title 2.txt` based on
119
+ the clippings's book title information.
120
+ test_files: []