noter 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: b68ee4841d7fc0d326ec4ea7d1244b7848c0b11e
4
+ data.tar.gz: 71616a574e1d1df9803564b1bd884d426943362f
5
+ SHA512:
6
+ metadata.gz: 65af15904825428047f8c0cd757a2c540f68f83bf1c5dea571bcaaa663133bdc074555bfb585ea6102f69e85ba224df90cd81bf3f5ea96440f77bb809994d8aa
7
+ data.tar.gz: 1c3e5dd61c8b9470efc9c4cf3068df6edf912a96e21ff3d2abe55f677c3eb29c893cda8f6b66c15438a87bf54f9d7b325dfb9caf6cde3ff07c6ca20622612ade
data/.gitignore ADDED
@@ -0,0 +1,18 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
18
+ .ruby-*
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in noter.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2014 Jeff Roush
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,31 @@
1
+ # Noter
2
+
3
+ Dumps text into timestamped files under ~/.notes.
4
+
5
+ Use it for keeping a journal, or for short -- or long -- notes during the workday.
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ gem 'noter'
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install noter
20
+
21
+ ## Usage
22
+
23
+ TODO: Write usage instructions here
24
+
25
+ ## Contributing
26
+
27
+ 1. Fork it ( http://github.com/<my-github-username>/noter/fork )
28
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
29
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
30
+ 4. Push to the branch (`git push origin my-new-feature`)
31
+ 5. Create new Pull Request
data/Rakefile ADDED
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
data/bin/noter ADDED
@@ -0,0 +1,22 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "noter"
4
+ require "optparse"
5
+
6
+ class NoteRunner
7
+ def run(args)
8
+ parser = OptionParser.new do |opts|
9
+ opts.on("-f", "--file FILE", "Use the specified file as the note") do |filename|
10
+ Noter::FileMaker.new.make_from_file(filename)
11
+ end
12
+
13
+ opts.on("-m", "--message MESSAGE", "Use the given message as the note") do |message|
14
+ Noter::FileMaker.new(message).save_file
15
+ end
16
+ end
17
+ parser.parse!
18
+ end
19
+ end
20
+
21
+ runner = NoteRunner.new
22
+ runner.run(ARGV)
@@ -0,0 +1,32 @@
1
+ require "fileutils"
2
+
3
+ module Noter
4
+ class FileMaker
5
+ attr_reader :content, :filename
6
+
7
+ def initialize(content = nil, filename = nil)
8
+ @content = content
9
+ @filename = filename
10
+ end
11
+
12
+ def dir
13
+ "#{ENV['HOME']}/.notes"
14
+ end
15
+
16
+ def new_filename
17
+ @filename ||= "#{dir}/#{Time.now.strftime('%Y_%m_%d_%H_%M_%S.txt')}"
18
+ end
19
+
20
+ def save_file
21
+ unless File.exist?(dir)
22
+ FileUtils.mkpath(dir)
23
+ end
24
+ File.write(new_filename, content)
25
+ end
26
+
27
+ def make_from_file(filename)
28
+ content = File.read(filename)
29
+ File.write(new_filename, content)
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,3 @@
1
+ module Noter
2
+ VERSION = "0.0.1"
3
+ end
data/lib/noter.rb ADDED
@@ -0,0 +1,6 @@
1
+ require "noter/version"
2
+ require "noter/file_maker"
3
+
4
+ module Noter
5
+
6
+ end
data/noter.gemspec ADDED
@@ -0,0 +1,28 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'noter/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "noter"
8
+ spec.version = Noter::VERSION
9
+ spec.authors = ["Jeff Roush"]
10
+ spec.email = ["jeff@jeffroush.com"]
11
+ spec.summary = %q{Creates timestamped notes.}
12
+ spec.description = %q{Inspired (read: stolen) from the 'journal' and 'jrnl' python progrsm. At the moment, those are more developed; use them instead of this.}
13
+ spec.homepage = "https://github.com/jeff-r/noter"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files`.split($/)
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.5"
22
+ spec.add_development_dependency "rake", "~> 10.3"
23
+ spec.add_development_dependency "rspec", "~> 3.1"
24
+ spec.add_development_dependency "timecop", "~> 0.7"
25
+ spec.add_development_dependency "fakefs", "~> 0.5"
26
+ spec.add_development_dependency "pry", "~> 0.10"
27
+ spec.add_development_dependency "pry-nav", "~> 0.2"
28
+ end
@@ -0,0 +1,62 @@
1
+ require "noter"
2
+ require "timecop"
3
+ require "pp" # to avoid an error in fakefs
4
+ require "fakefs"
5
+ require "pry"
6
+ require "pry-nav"
7
+
8
+ module Noter
9
+ describe FileMaker do
10
+ let(:maker) { FileMaker.new }
11
+
12
+ describe "#new_filename" do
13
+ it "generates a new filename" do
14
+ Timecop.freeze(Time.local(2014,9,20,22,14,0,0)) do
15
+ expect(maker.new_filename).to eql("#{maker.dir}/2014_09_20_22_14_00.txt")
16
+ end
17
+ end
18
+ end
19
+
20
+ describe "with a filename and content" do
21
+ let(:maker) { FileMaker.new("some content", "file.txt") }
22
+
23
+ describe "#save_to_file" do
24
+ it "saves to a file" do
25
+ expect(File).to receive(:write).with("file.txt", "some content")
26
+ maker.save_file
27
+ end
28
+ end
29
+ end
30
+
31
+ describe "when the directory doesn't already exist" do
32
+ let(:maker) { FileMaker.new("some content", "file.txt") }
33
+
34
+ before do
35
+ if Dir.exist?(maker.dir)
36
+ FileUtils.rm_rf maker.dir
37
+ end
38
+ end
39
+
40
+ it "creates the directory" do
41
+ expect(Dir.exist?(maker.dir)).to be false
42
+ maker.save_file
43
+ expect(Dir.exist?(maker.dir)).to be true
44
+ end
45
+ end
46
+
47
+ describe "#make_from_file" do
48
+ before do
49
+ unless Dir.exist?(maker.dir)
50
+ FileUtils.mkdir maker.dir
51
+ end
52
+ File.write("foo.txt", "some content")
53
+ end
54
+
55
+ it "saves to a file" do
56
+ maker.make_from_file("foo.txt")
57
+ content = File.read(maker.new_filename)
58
+ expect(content).to eql("some content")
59
+ end
60
+ end
61
+ end
62
+ end
metadata ADDED
@@ -0,0 +1,156 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: noter
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Jeff Roush
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-09-21 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.5'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.5'
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.3'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.3'
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.1'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.1'
55
+ - !ruby/object:Gem::Dependency
56
+ name: timecop
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '0.7'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '0.7'
69
+ - !ruby/object:Gem::Dependency
70
+ name: fakefs
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '0.5'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '0.5'
83
+ - !ruby/object:Gem::Dependency
84
+ name: pry
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '0.10'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '0.10'
97
+ - !ruby/object:Gem::Dependency
98
+ name: pry-nav
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '0.2'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '0.2'
111
+ description: 'Inspired (read: stolen) from the ''journal'' and ''jrnl'' python progrsm.
112
+ At the moment, those are more developed; use them instead of this.'
113
+ email:
114
+ - jeff@jeffroush.com
115
+ executables:
116
+ - noter
117
+ extensions: []
118
+ extra_rdoc_files: []
119
+ files:
120
+ - ".gitignore"
121
+ - Gemfile
122
+ - LICENSE.txt
123
+ - README.md
124
+ - Rakefile
125
+ - bin/noter
126
+ - lib/noter.rb
127
+ - lib/noter/file_maker.rb
128
+ - lib/noter/version.rb
129
+ - noter.gemspec
130
+ - spec/lib/noter/file_maker_spec.rb
131
+ homepage: https://github.com/jeff-r/noter
132
+ licenses:
133
+ - MIT
134
+ metadata: {}
135
+ post_install_message:
136
+ rdoc_options: []
137
+ require_paths:
138
+ - lib
139
+ required_ruby_version: !ruby/object:Gem::Requirement
140
+ requirements:
141
+ - - ">="
142
+ - !ruby/object:Gem::Version
143
+ version: '0'
144
+ required_rubygems_version: !ruby/object:Gem::Requirement
145
+ requirements:
146
+ - - ">="
147
+ - !ruby/object:Gem::Version
148
+ version: '0'
149
+ requirements: []
150
+ rubyforge_project:
151
+ rubygems_version: 2.2.0
152
+ signing_key:
153
+ specification_version: 4
154
+ summary: Creates timestamped notes.
155
+ test_files:
156
+ - spec/lib/noter/file_maker_spec.rb