snippit 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: f9e6f255093428dc4ac4db2ce12c14e9d78e45f1cdfb07eeccb19ea7736bef6e
4
+ data.tar.gz: a764c0e2abaffd53c42bd1556cc9ce76bf9fd2ce7b596299eb61fe0fadbe297d
5
+ SHA512:
6
+ metadata.gz: 72f6978a479de66cbe424658b48fce6f0f85b8015c58b193b5d967b9eca4966b10d5ecf0287e67007485db551c202b7d15096a9311fe2c5ece7ebe67b25fc51e
7
+ data.tar.gz: 03b95c849abf6b52e9f09b8681531b47b3fc9d5a8dd8015ba40293835d4c8144afd09aff57959499efafd6cc55b3629898df60bcbb5675ccefebefd71eb293c9
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ source 'https://rubygems.org'
4
+
5
+ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
6
+
7
+ gemspec
data/Gemfile.lock ADDED
@@ -0,0 +1,92 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ snippit (0.0.1)
5
+
6
+ GEM
7
+ remote: https://rubygems.org/
8
+ specs:
9
+ ast (2.4.2)
10
+ awesome_print (1.9.2)
11
+ childprocess (4.1.0)
12
+ diff-lcs (1.5.0)
13
+ docile (1.4.0)
14
+ iniparse (1.5.0)
15
+ json (2.6.3)
16
+ overcommit (0.59.1)
17
+ childprocess (>= 0.6.3, < 5)
18
+ iniparse (~> 1.4)
19
+ rexml (~> 3.2)
20
+ parallel (1.22.1)
21
+ parser (3.1.3.0)
22
+ ast (~> 2.4.1)
23
+ rainbow (3.1.1)
24
+ rake (13.0.6)
25
+ regexp_parser (2.6.1)
26
+ rexml (3.2.5)
27
+ rspec (3.12.0)
28
+ rspec-core (~> 3.12.0)
29
+ rspec-expectations (~> 3.12.0)
30
+ rspec-mocks (~> 3.12.0)
31
+ rspec-core (3.12.0)
32
+ rspec-support (~> 3.12.0)
33
+ rspec-expectations (3.12.0)
34
+ diff-lcs (>= 1.2.0, < 2.0)
35
+ rspec-support (~> 3.12.0)
36
+ rspec-mocks (3.12.0)
37
+ diff-lcs (>= 1.2.0, < 2.0)
38
+ rspec-support (~> 3.12.0)
39
+ rspec-snapshot (2.0.1)
40
+ awesome_print (> 1.0.0)
41
+ rspec (> 3.0.0)
42
+ rspec-support (3.12.0)
43
+ rubocop (1.40.0)
44
+ json (~> 2.3)
45
+ parallel (~> 1.10)
46
+ parser (>= 3.1.2.1)
47
+ rainbow (>= 2.2.2, < 4.0)
48
+ regexp_parser (>= 1.8, < 3.0)
49
+ rexml (>= 3.2.5, < 4.0)
50
+ rubocop-ast (>= 1.23.0, < 2.0)
51
+ ruby-progressbar (~> 1.7)
52
+ unicode-display_width (>= 1.4.0, < 3.0)
53
+ rubocop-ast (1.24.0)
54
+ parser (>= 3.1.1.0)
55
+ rubocop-rake (0.6.0)
56
+ rubocop (~> 1.0)
57
+ rubocop-rspec (2.15.0)
58
+ rubocop (~> 1.33)
59
+ ruby-progressbar (1.11.0)
60
+ simplecov (0.21.2)
61
+ docile (~> 1.1)
62
+ simplecov-html (~> 0.11)
63
+ simplecov_json_formatter (~> 0.1)
64
+ simplecov-cobertura (2.1.0)
65
+ rexml
66
+ simplecov (~> 0.19)
67
+ simplecov-html (0.12.3)
68
+ simplecov_json_formatter (0.1.4)
69
+ unicode-display_width (2.3.0)
70
+ webrick (1.7.0)
71
+ yard (0.9.28)
72
+ webrick (~> 1.7.0)
73
+
74
+ PLATFORMS
75
+ ruby
76
+
77
+ DEPENDENCIES
78
+ bundler (~> 2.0)
79
+ overcommit (~> 0.59)
80
+ rake (~> 13.0)
81
+ rspec (~> 3.11)
82
+ rspec-snapshot (~> 2.0)
83
+ rubocop (~> 1.36)
84
+ rubocop-rake (~> 0.6)
85
+ rubocop-rspec (~> 2.13)
86
+ simplecov (~> 0.21)
87
+ simplecov-cobertura (~> 2.1)
88
+ snippit!
89
+ yard (~> 0.9.28)
90
+
91
+ BUNDLED WITH
92
+ 2.1.2
data/README.md ADDED
@@ -0,0 +1,25 @@
1
+ # Snippit (WIP)
2
+
3
+ [![CI](https://github.com/spenserblack/snippit/actions/workflows/ci.yml/badge.svg)](https://github.com/spenserblack/snippit/actions/workflows/ci.yml)
4
+ [![CodeQL](https://github.com/spenserblack/snippit/actions/workflows/codeql.yml/badge.svg)](https://github.com/spenserblack/snippit/actions/workflows/codeql.yml)
5
+ [![codecov](https://codecov.io/gh/spenserblack/snippit/branch/main/graph/badge.svg?token=5yr1302Knn)](https://codecov.io/gh/spenserblack/snippit)
6
+
7
+ Define, store, and output your code snippets.
8
+
9
+ ## (Proposed) Usage
10
+
11
+ All uses of `snippit` can be replaced with the shortcut `snip`.
12
+
13
+ ```console
14
+ # Define a snippet called "hello-world.js"
15
+ $ snippit save hello-world.js
16
+
17
+ # Make a code snippet called "Hello World (JS)" from STDIN
18
+ $ echo "console.log('Hello, World!');" | snippit save --name "Hello World (JS)"
19
+
20
+ # Output the "Hello World (JS)" snippet to a file called "index.js"
21
+ $ snippit out "Hello World (JS)" > index.js
22
+
23
+ # List all of your code snippets
24
+ $ snippit list
25
+ ```
data/Rakefile ADDED
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'bundler/setup'
4
+ require 'rake'
5
+
6
+ require 'rspec/core/rake_task'
7
+ require 'rubocop/rake_task'
8
+ require 'yard'
9
+
10
+ RSpec::Core::RakeTask.new(:spec)
11
+ RuboCop::RakeTask.new(:format) do |t|
12
+ t.requires << 'rubocop-rspec'
13
+ end
14
+ YARD::Rake::YardocTask.new(:doc)
15
+
16
+ desc 'Run tests'
17
+ task default: %i[format spec]
data/exe/snip ADDED
@@ -0,0 +1,6 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ require 'snippit/cli'
5
+
6
+ Snippit::CLI.start(ARGV)
data/exe/snippit ADDED
@@ -0,0 +1,6 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ require 'snippit/cli'
5
+
6
+ Snippit::CLI.start(ARGV)
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'snippit'
4
+
5
+ module Snippit
6
+ # Snippit::CLI is the command line interface for Snippit.
7
+ class CLI
8
+ def self.start(args)
9
+ new(args).run
10
+ end
11
+
12
+ def initialize(args)
13
+ @args = args
14
+ end
15
+
16
+ def run
17
+ puts 'Hello, world!'
18
+ end
19
+ end
20
+ end
data/lib/snippit.rb ADDED
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Snippit manages code snippets.
4
+ module Snippit
5
+ # Snippit::DEFINITIONS is a reserved filename for the snippet definitions.
6
+ DEFINITIONS = '__definitions__.yml'
7
+
8
+ attr_reader :snippit_dir
9
+
10
+ def initialize(snippit_dir)
11
+ @snippit_dir = snippit_dir
12
+ end
13
+
14
+ def definitions_filename
15
+ File.join(snippit_dir, DEFINITIONS)
16
+ end
17
+ end
metadata ADDED
@@ -0,0 +1,212 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: snippit
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Spenser Black
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2022-12-13 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: '2.0'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '2.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: overcommit
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '0.59'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '0.59'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '13.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '13.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.11'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.11'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rspec-snapshot
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '2.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '2.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rubocop
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '1.36'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '1.36'
97
+ - !ruby/object:Gem::Dependency
98
+ name: rubocop-rake
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '0.6'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '0.6'
111
+ - !ruby/object:Gem::Dependency
112
+ name: rubocop-rspec
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '2.13'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: '2.13'
125
+ - !ruby/object:Gem::Dependency
126
+ name: simplecov
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: '0.21'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: '0.21'
139
+ - !ruby/object:Gem::Dependency
140
+ name: simplecov-cobertura
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - "~>"
144
+ - !ruby/object:Gem::Version
145
+ version: '2.1'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - "~>"
151
+ - !ruby/object:Gem::Version
152
+ version: '2.1'
153
+ - !ruby/object:Gem::Dependency
154
+ name: yard
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - "~>"
158
+ - !ruby/object:Gem::Version
159
+ version: 0.9.28
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - "~>"
165
+ - !ruby/object:Gem::Version
166
+ version: 0.9.28
167
+ description: Define, store, and output your code snippets
168
+ email:
169
+ executables:
170
+ - snip
171
+ - snippit
172
+ extensions: []
173
+ extra_rdoc_files: []
174
+ files:
175
+ - Gemfile
176
+ - Gemfile.lock
177
+ - README.md
178
+ - Rakefile
179
+ - exe/snip
180
+ - exe/snippit
181
+ - lib/snippit.rb
182
+ - lib/snippit/cli.rb
183
+ homepage: https://github.com/spenserblack/snippit
184
+ licenses:
185
+ - MIT
186
+ metadata:
187
+ homepage_uri: https://github.com/spenserblack/snippit
188
+ changelog_uri: https://github.com/spenserblack/snippit/releases
189
+ documentation_uri: https://rubydoc.info/gems/snippit
190
+ source_code_uri: https://github.com/spenserblack/snippit
191
+ github_repo: ssh://github.com/spenserblack/snippit
192
+ rubygems_mfa_required: 'true'
193
+ post_install_message:
194
+ rdoc_options: []
195
+ require_paths:
196
+ - lib
197
+ required_ruby_version: !ruby/object:Gem::Requirement
198
+ requirements:
199
+ - - ">="
200
+ - !ruby/object:Gem::Version
201
+ version: 2.6.0
202
+ required_rubygems_version: !ruby/object:Gem::Requirement
203
+ requirements:
204
+ - - ">="
205
+ - !ruby/object:Gem::Version
206
+ version: '0'
207
+ requirements: []
208
+ rubygems_version: 3.1.2
209
+ signing_key:
210
+ specification_version: 4
211
+ summary: Manage your personal code snippets
212
+ test_files: []