tins 1.44.0 → 1.44.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 +4 -4
- data/CHANGES.md +9 -0
- data/README.md +1 -1
- data/Rakefile +1 -1
- data/lib/tins/version.rb +1 -1
- data/tests/test_helper.rb +5 -2
- data/tins.gemspec +3 -3
- metadata +1 -6
- data/.contexts/code_comment.rb +0 -23
- data/.contexts/full.rb +0 -31
- data/.contexts/lib.rb +0 -24
- data/.contexts/yard.md +0 -92
- data/.github/workflows/codeql-analysis.yml +0 -72
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: dea8b09113e54baa0b79f271dcac56a05623938cfcf59936997a74e76f20a250
|
|
4
|
+
data.tar.gz: dcd68ba95e4178255f5198e7f0a28812f13061aa4c0086bb06cd4d41bd131db3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ce4055137e119adc1e3d7eb19cf367075ed65e153f7c07376d4f1b737beaff0096c975625a06b4fd434bed30e0e201f5ff397641a044a98bb92fa9167fb15cc5
|
|
7
|
+
data.tar.gz: 968434c46941904d1deda42a10198d40fb127f43497c4e203e44fdc7c87d7d57366c4f0c61e6ccb1401de0a77c57f21e395708cd7868eabab95e8def759f7c69
|
data/CHANGES.md
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# Changes
|
|
2
2
|
|
|
3
|
+
## 2025-09-13 v1.44.1
|
|
4
|
+
|
|
5
|
+
- Updated documentation link in README.md to point to GitHub.io instead of
|
|
6
|
+
RubyDoc.info
|
|
7
|
+
- Added graceful handling for missing `gem_hadar/simplecov` gem by wrapping
|
|
8
|
+
require and start in begin/rescue block to catch `LoadError`
|
|
9
|
+
- Modified gem packaging to include all files in `.github` and `.contexts` directories using `FileList` for dynamic inclusion
|
|
10
|
+
- Created `static.yml` file
|
|
11
|
+
|
|
3
12
|
## 2025-09-12 v1.44.0
|
|
4
13
|
|
|
5
14
|
### Major Changes
|
data/README.md
CHANGED
data/Rakefile
CHANGED
|
@@ -16,7 +16,7 @@ GemHadar do
|
|
|
16
16
|
'.rbx', '.AppleDouble', '.DS_Store', 'tags', 'cscope.out', '.bundle',
|
|
17
17
|
'.byebug_history', '.yardoc', 'doc', 'TODO.md'
|
|
18
18
|
package_ignore '.all_images.yml', '.tool-versions', '.gitignore',
|
|
19
|
-
'VERSION', '.utilsrc', '.github', '.contexts'
|
|
19
|
+
'VERSION', '.utilsrc', *FileList['.github/**/*'], *FileList['.contexts/*']
|
|
20
20
|
|
|
21
21
|
readme 'README.md'
|
|
22
22
|
licenses << 'MIT'
|
data/lib/tins/version.rb
CHANGED
data/tests/test_helper.rb
CHANGED
data/tins.gemspec
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# -*- encoding: utf-8 -*-
|
|
2
|
-
# stub: tins 1.44.
|
|
2
|
+
# stub: tins 1.44.1 ruby lib
|
|
3
3
|
|
|
4
4
|
Gem::Specification.new do |s|
|
|
5
5
|
s.name = "tins".freeze
|
|
6
|
-
s.version = "1.44.
|
|
6
|
+
s.version = "1.44.1".freeze
|
|
7
7
|
|
|
8
8
|
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
|
|
9
9
|
s.require_paths = ["lib".freeze]
|
|
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
|
|
|
12
12
|
s.description = "All the stuff that isn't good/big enough for a real library.".freeze
|
|
13
13
|
s.email = "flori@ping.de".freeze
|
|
14
14
|
s.extra_rdoc_files = ["README.md".freeze, "lib/dslkit.rb".freeze, "lib/dslkit/polite.rb".freeze, "lib/dslkit/rude.rb".freeze, "lib/spruz.rb".freeze, "lib/tins.rb".freeze, "lib/tins/alias.rb".freeze, "lib/tins/annotate.rb".freeze, "lib/tins/ask_and_send.rb".freeze, "lib/tins/attempt.rb".freeze, "lib/tins/bijection.rb".freeze, "lib/tins/case_predicate.rb".freeze, "lib/tins/complete.rb".freeze, "lib/tins/concern.rb".freeze, "lib/tins/date_dummy.rb".freeze, "lib/tins/date_time_dummy.rb".freeze, "lib/tins/deep_dup.rb".freeze, "lib/tins/deprecate.rb".freeze, "lib/tins/dslkit.rb".freeze, "lib/tins/duration.rb".freeze, "lib/tins/expose.rb".freeze, "lib/tins/extract_last_argument_options.rb".freeze, "lib/tins/file_binary.rb".freeze, "lib/tins/find.rb".freeze, "lib/tins/generator.rb".freeze, "lib/tins/go.rb".freeze, "lib/tins/hash_bfs.rb".freeze, "lib/tins/hash_symbolize_keys_recursive.rb".freeze, "lib/tins/hash_union.rb".freeze, "lib/tins/if_predicate.rb".freeze, "lib/tins/implement.rb".freeze, "lib/tins/limited.rb".freeze, "lib/tins/lines_file.rb".freeze, "lib/tins/lru_cache.rb".freeze, "lib/tins/memoize.rb".freeze, "lib/tins/method_description.rb".freeze, "lib/tins/minimize.rb".freeze, "lib/tins/module_group.rb".freeze, "lib/tins/named_set.rb".freeze, "lib/tins/null.rb".freeze, "lib/tins/once.rb".freeze, "lib/tins/p.rb".freeze, "lib/tins/partial_application.rb".freeze, "lib/tins/proc_compose.rb".freeze, "lib/tins/proc_prelude.rb".freeze, "lib/tins/range_plus.rb".freeze, "lib/tins/require_maybe.rb".freeze, "lib/tins/responding.rb".freeze, "lib/tins/secure_write.rb".freeze, "lib/tins/sexy_singleton.rb".freeze, "lib/tins/string_byte_order_mark.rb".freeze, "lib/tins/string_camelize.rb".freeze, "lib/tins/string_named_placeholders.rb".freeze, "lib/tins/string_underscore.rb".freeze, "lib/tins/string_version.rb".freeze, "lib/tins/subhash.rb".freeze, "lib/tins/temp_io.rb".freeze, "lib/tins/temp_io_enum.rb".freeze, "lib/tins/terminal.rb".freeze, "lib/tins/thread_local.rb".freeze, "lib/tins/time_dummy.rb".freeze, "lib/tins/to.rb".freeze, "lib/tins/to_proc.rb".freeze, "lib/tins/token.rb".freeze, "lib/tins/unit.rb".freeze, "lib/tins/version.rb".freeze, "lib/tins/write.rb".freeze, "lib/tins/xt.rb".freeze, "lib/tins/xt/annotate.rb".freeze, "lib/tins/xt/ask_and_send.rb".freeze, "lib/tins/xt/attempt.rb".freeze, "lib/tins/xt/blank.rb".freeze, "lib/tins/xt/case_predicate.rb".freeze, "lib/tins/xt/complete.rb".freeze, "lib/tins/xt/concern.rb".freeze, "lib/tins/xt/date_dummy.rb".freeze, "lib/tins/xt/date_time_dummy.rb".freeze, "lib/tins/xt/deep_dup.rb".freeze, "lib/tins/xt/deprecate.rb".freeze, "lib/tins/xt/dslkit.rb".freeze, "lib/tins/xt/expose.rb".freeze, "lib/tins/xt/extract_last_argument_options.rb".freeze, "lib/tins/xt/file_binary.rb".freeze, "lib/tins/xt/full.rb".freeze, "lib/tins/xt/hash_bfs.rb".freeze, "lib/tins/xt/hash_symbolize_keys_recursive.rb".freeze, "lib/tins/xt/hash_union.rb".freeze, "lib/tins/xt/if_predicate.rb".freeze, "lib/tins/xt/implement.rb".freeze, "lib/tins/xt/irb.rb".freeze, "lib/tins/xt/method_description.rb".freeze, "lib/tins/xt/minimize.rb".freeze, "lib/tins/xt/named.rb".freeze, "lib/tins/xt/null.rb".freeze, "lib/tins/xt/p.rb".freeze, "lib/tins/xt/partial_application.rb".freeze, "lib/tins/xt/proc_compose.rb".freeze, "lib/tins/xt/proc_prelude.rb".freeze, "lib/tins/xt/range_plus.rb".freeze, "lib/tins/xt/require_maybe.rb".freeze, "lib/tins/xt/responding.rb".freeze, "lib/tins/xt/secure_write.rb".freeze, "lib/tins/xt/sexy_singleton.rb".freeze, "lib/tins/xt/string.rb".freeze, "lib/tins/xt/string_byte_order_mark.rb".freeze, "lib/tins/xt/string_camelize.rb".freeze, "lib/tins/xt/string_named_placeholders.rb".freeze, "lib/tins/xt/string_underscore.rb".freeze, "lib/tins/xt/string_version.rb".freeze, "lib/tins/xt/subhash.rb".freeze, "lib/tins/xt/temp_io.rb".freeze, "lib/tins/xt/time_dummy.rb".freeze, "lib/tins/xt/time_freezer.rb".freeze, "lib/tins/xt/to.rb".freeze, "lib/tins/xt/write.rb".freeze]
|
|
15
|
-
s.files = ["
|
|
15
|
+
s.files = ["CHANGES.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "examples/add_one.png".freeze, "examples/add_one.stm".freeze, "examples/bb3.png".freeze, "examples/bb3.stm".freeze, "examples/concatenate_compare.mtm".freeze, "examples/concatenate_compare.png".freeze, "examples/length_difference.mtm".freeze, "examples/length_difference.png".freeze, "examples/let.rb".freeze, "examples/mail.rb".freeze, "examples/minsky.rb".freeze, "examples/multiply.reg".freeze, "examples/null_pattern.rb".freeze, "examples/ones_difference-mtm.png".freeze, "examples/ones_difference-stm.png".freeze, "examples/ones_difference.mtm".freeze, "examples/ones_difference.stm".freeze, "examples/prefix-equals-suffix-reversed-with-infix.png".freeze, "examples/prefix-equals-suffix-reversed-with-infix.stm".freeze, "examples/recipe.rb".freeze, "examples/recipe2.rb".freeze, "examples/recipe_common.rb".freeze, "examples/subtract.reg".freeze, "examples/turing-graph.rb".freeze, "examples/turing.rb".freeze, "lib/dslkit.rb".freeze, "lib/dslkit/polite.rb".freeze, "lib/dslkit/rude.rb".freeze, "lib/spruz".freeze, "lib/spruz.rb".freeze, "lib/tins.rb".freeze, "lib/tins/alias.rb".freeze, "lib/tins/annotate.rb".freeze, "lib/tins/ask_and_send.rb".freeze, "lib/tins/attempt.rb".freeze, "lib/tins/bijection.rb".freeze, "lib/tins/case_predicate.rb".freeze, "lib/tins/complete.rb".freeze, "lib/tins/concern.rb".freeze, "lib/tins/date_dummy.rb".freeze, "lib/tins/date_time_dummy.rb".freeze, "lib/tins/deep_dup.rb".freeze, "lib/tins/deprecate.rb".freeze, "lib/tins/dslkit.rb".freeze, "lib/tins/duration.rb".freeze, "lib/tins/expose.rb".freeze, "lib/tins/extract_last_argument_options.rb".freeze, "lib/tins/file_binary.rb".freeze, "lib/tins/find.rb".freeze, "lib/tins/generator.rb".freeze, "lib/tins/go.rb".freeze, "lib/tins/hash_bfs.rb".freeze, "lib/tins/hash_symbolize_keys_recursive.rb".freeze, "lib/tins/hash_union.rb".freeze, "lib/tins/if_predicate.rb".freeze, "lib/tins/implement.rb".freeze, "lib/tins/limited.rb".freeze, "lib/tins/lines_file.rb".freeze, "lib/tins/lru_cache.rb".freeze, "lib/tins/memoize.rb".freeze, "lib/tins/method_description.rb".freeze, "lib/tins/minimize.rb".freeze, "lib/tins/module_group.rb".freeze, "lib/tins/named_set.rb".freeze, "lib/tins/null.rb".freeze, "lib/tins/once.rb".freeze, "lib/tins/p.rb".freeze, "lib/tins/partial_application.rb".freeze, "lib/tins/proc_compose.rb".freeze, "lib/tins/proc_prelude.rb".freeze, "lib/tins/range_plus.rb".freeze, "lib/tins/require_maybe.rb".freeze, "lib/tins/responding.rb".freeze, "lib/tins/secure_write.rb".freeze, "lib/tins/sexy_singleton.rb".freeze, "lib/tins/string_byte_order_mark.rb".freeze, "lib/tins/string_camelize.rb".freeze, "lib/tins/string_named_placeholders.rb".freeze, "lib/tins/string_underscore.rb".freeze, "lib/tins/string_version.rb".freeze, "lib/tins/subhash.rb".freeze, "lib/tins/temp_io.rb".freeze, "lib/tins/temp_io_enum.rb".freeze, "lib/tins/terminal.rb".freeze, "lib/tins/thread_local.rb".freeze, "lib/tins/time_dummy.rb".freeze, "lib/tins/to.rb".freeze, "lib/tins/to_proc.rb".freeze, "lib/tins/token.rb".freeze, "lib/tins/unit.rb".freeze, "lib/tins/version.rb".freeze, "lib/tins/write.rb".freeze, "lib/tins/xt.rb".freeze, "lib/tins/xt/annotate.rb".freeze, "lib/tins/xt/ask_and_send.rb".freeze, "lib/tins/xt/attempt.rb".freeze, "lib/tins/xt/blank.rb".freeze, "lib/tins/xt/case_predicate.rb".freeze, "lib/tins/xt/complete.rb".freeze, "lib/tins/xt/concern.rb".freeze, "lib/tins/xt/date_dummy.rb".freeze, "lib/tins/xt/date_time_dummy.rb".freeze, "lib/tins/xt/deep_dup.rb".freeze, "lib/tins/xt/deprecate.rb".freeze, "lib/tins/xt/dslkit.rb".freeze, "lib/tins/xt/expose.rb".freeze, "lib/tins/xt/extract_last_argument_options.rb".freeze, "lib/tins/xt/file_binary.rb".freeze, "lib/tins/xt/full.rb".freeze, "lib/tins/xt/hash_bfs.rb".freeze, "lib/tins/xt/hash_symbolize_keys_recursive.rb".freeze, "lib/tins/xt/hash_union.rb".freeze, "lib/tins/xt/if_predicate.rb".freeze, "lib/tins/xt/implement.rb".freeze, "lib/tins/xt/irb.rb".freeze, "lib/tins/xt/method_description.rb".freeze, "lib/tins/xt/minimize.rb".freeze, "lib/tins/xt/named.rb".freeze, "lib/tins/xt/null.rb".freeze, "lib/tins/xt/p.rb".freeze, "lib/tins/xt/partial_application.rb".freeze, "lib/tins/xt/proc_compose.rb".freeze, "lib/tins/xt/proc_prelude.rb".freeze, "lib/tins/xt/range_plus.rb".freeze, "lib/tins/xt/require_maybe.rb".freeze, "lib/tins/xt/responding.rb".freeze, "lib/tins/xt/secure_write.rb".freeze, "lib/tins/xt/sexy_singleton.rb".freeze, "lib/tins/xt/string.rb".freeze, "lib/tins/xt/string_byte_order_mark.rb".freeze, "lib/tins/xt/string_camelize.rb".freeze, "lib/tins/xt/string_named_placeholders.rb".freeze, "lib/tins/xt/string_underscore.rb".freeze, "lib/tins/xt/string_version.rb".freeze, "lib/tins/xt/subhash.rb".freeze, "lib/tins/xt/temp_io.rb".freeze, "lib/tins/xt/time_dummy.rb".freeze, "lib/tins/xt/time_freezer.rb".freeze, "lib/tins/xt/to.rb".freeze, "lib/tins/xt/write.rb".freeze, "tests/annotate_test.rb".freeze, "tests/ask_and_send_test.rb".freeze, "tests/attempt_test.rb".freeze, "tests/bijection_test.rb".freeze, "tests/blank_full_test.rb".freeze, "tests/case_predicate_test.rb".freeze, "tests/concern_test.rb".freeze, "tests/date_dummy_test.rb".freeze, "tests/date_time_dummy_test.rb".freeze, "tests/deep_dup_test.rb".freeze, "tests/delegate_test.rb".freeze, "tests/deprecate_test.rb".freeze, "tests/dslkit_test.rb".freeze, "tests/duration_test.rb".freeze, "tests/dynamic_scope_test.rb".freeze, "tests/expose_test.rb".freeze, "tests/extract_last_argument_options_test.rb".freeze, "tests/file_binary_test.rb".freeze, "tests/find_test.rb".freeze, "tests/from_module_test.rb".freeze, "tests/generator_test.rb".freeze, "tests/go_test.rb".freeze, "tests/hash_bfs_test.rb".freeze, "tests/hash_symbolize_keys_recursive_test.rb".freeze, "tests/hash_union_test.rb".freeze, "tests/if_predicate_test.rb".freeze, "tests/implement_test.rb".freeze, "tests/limited_test.rb".freeze, "tests/lines_file_test.rb".freeze, "tests/lru_cache_test.rb".freeze, "tests/memoize_test.rb".freeze, "tests/method_description_test.rb".freeze, "tests/minimize_test.rb".freeze, "tests/module_group_test.rb".freeze, "tests/named_set_test.rb".freeze, "tests/named_test.rb".freeze, "tests/null_test.rb".freeze, "tests/p_test.rb".freeze, "tests/partial_application_test.rb".freeze, "tests/proc_compose_test.rb".freeze, "tests/proc_prelude_test.rb".freeze, "tests/range_plus_test.rb".freeze, "tests/require_maybe_test.rb".freeze, "tests/responding_test.rb".freeze, "tests/rotate_test.rb".freeze, "tests/scope_test.rb".freeze, "tests/secure_write_test.rb".freeze, "tests/sexy_singleton_test.rb".freeze, "tests/string_byte_order_mark_test.rb".freeze, "tests/string_camelize_test.rb".freeze, "tests/string_named_placeholders.rb".freeze, "tests/string_underscore_test.rb".freeze, "tests/string_version_test.rb".freeze, "tests/subhash_test.rb".freeze, "tests/temp_io_test.rb".freeze, "tests/test_helper.rb".freeze, "tests/time_dummy_test.rb".freeze, "tests/time_freezer_test.rb".freeze, "tests/to_test.rb".freeze, "tests/token_test.rb".freeze, "tests/unit_test.rb".freeze, "tins.gemspec".freeze]
|
|
16
16
|
s.homepage = "https://github.com/flori/tins".freeze
|
|
17
17
|
s.licenses = ["MIT".freeze]
|
|
18
18
|
s.rdoc_options = ["--title".freeze, "Tins - Useful stuff.".freeze, "--main".freeze, "README.md".freeze]
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: tins
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.44.
|
|
4
|
+
version: 1.44.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Florian Frank
|
|
@@ -256,11 +256,6 @@ extra_rdoc_files:
|
|
|
256
256
|
- lib/tins/xt/to.rb
|
|
257
257
|
- lib/tins/xt/write.rb
|
|
258
258
|
files:
|
|
259
|
-
- ".contexts/code_comment.rb"
|
|
260
|
-
- ".contexts/full.rb"
|
|
261
|
-
- ".contexts/lib.rb"
|
|
262
|
-
- ".contexts/yard.md"
|
|
263
|
-
- ".github/workflows/codeql-analysis.yml"
|
|
264
259
|
- CHANGES.md
|
|
265
260
|
- Gemfile
|
|
266
261
|
- LICENSE
|
data/.contexts/code_comment.rb
DELETED
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
context do
|
|
2
|
-
namespace "lib" do
|
|
3
|
-
Dir['lib/**/*.rb'].each do |filename|
|
|
4
|
-
file filename, tags: 'lib'
|
|
5
|
-
end
|
|
6
|
-
end
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
file 'README.md', tags: 'documentation'
|
|
10
|
-
|
|
11
|
-
file '.contexts/yard.md', tags: [ 'yard', 'cheatsheet' ]
|
|
12
|
-
|
|
13
|
-
meta guidelines: <<~EOT
|
|
14
|
-
# Guidelines for creating YARD documentation
|
|
15
|
-
|
|
16
|
-
- Look into the file, with tags yard and cheatsheet for how comment ruby
|
|
17
|
-
constructs.
|
|
18
|
-
- In comments above initialize methods **ALWAYS** omit @return.
|
|
19
|
-
- **NEVER** output @return [ void ] in comments of any method, because
|
|
20
|
-
in Ruby every method returns something. If you don't know or if the
|
|
21
|
-
method is just called because its side effect just omit the @return.
|
|
22
|
-
EOT
|
|
23
|
-
end
|
data/.contexts/full.rb
DELETED
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
context do
|
|
2
|
-
variable project_name: Pathname.pwd.basename
|
|
3
|
-
|
|
4
|
-
variable project_version: File.read('VERSION').chomp
|
|
5
|
-
|
|
6
|
-
variable branch: `git rev-parse --abbrev-ref HEAD`.chomp
|
|
7
|
-
|
|
8
|
-
namespace "structure" do
|
|
9
|
-
command "tree", tags: %w[ project_structure ]
|
|
10
|
-
end
|
|
11
|
-
|
|
12
|
-
namespace "lib" do
|
|
13
|
-
Dir['lib/**/*.rb'].each do |filename|
|
|
14
|
-
file filename, tags: 'lib'
|
|
15
|
-
end
|
|
16
|
-
end
|
|
17
|
-
|
|
18
|
-
namespace "tests" do
|
|
19
|
-
Dir['tests/**/*.rb'].each do |filename|
|
|
20
|
-
file filename, tags: 'test'
|
|
21
|
-
end
|
|
22
|
-
end
|
|
23
|
-
|
|
24
|
-
file 'Rakefile', tags: 'gem_hadar'
|
|
25
|
-
|
|
26
|
-
file 'README.md', tags: 'documentation'
|
|
27
|
-
|
|
28
|
-
meta ruby: RUBY_DESCRIPTION
|
|
29
|
-
|
|
30
|
-
meta code_coverage: json('coverage/coverage_context.json')
|
|
31
|
-
end
|
data/.contexts/lib.rb
DELETED
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
context do
|
|
2
|
-
variable project_name: Pathname.pwd.basename
|
|
3
|
-
|
|
4
|
-
variable project_version: File.read('VERSION').chomp
|
|
5
|
-
|
|
6
|
-
variable branch: `git rev-parse --abbrev-ref HEAD`.chomp
|
|
7
|
-
|
|
8
|
-
namespace "structure" do
|
|
9
|
-
command "tree", tags: %w[ project_structure ]
|
|
10
|
-
end
|
|
11
|
-
|
|
12
|
-
namespace "lib" do
|
|
13
|
-
Dir['lib/**/*.rb'].each do |filename|
|
|
14
|
-
file filename, tags: 'lib'
|
|
15
|
-
end
|
|
16
|
-
end
|
|
17
|
-
|
|
18
|
-
file 'Rakefile', tags: 'gem_hadar'
|
|
19
|
-
|
|
20
|
-
file 'README.md', tags: 'documentation'
|
|
21
|
-
|
|
22
|
-
meta ruby: RUBY_DESCRIPTION
|
|
23
|
-
end
|
|
24
|
-
|
data/.contexts/yard.md
DELETED
|
@@ -1,92 +0,0 @@
|
|
|
1
|
-
# YARD CHEATSHEET http://yardoc.org
|
|
2
|
-
|
|
3
|
-
## May 2020 - updated fork: https://gist.github.com/phansch/db18a595d2f5f1ef16646af72fe1fb0e
|
|
4
|
-
|
|
5
|
-
cribbed from http://pastebin.com/xgzeAmBn
|
|
6
|
-
|
|
7
|
-
Templates to remind you of the options and formatting for the different types of objects you might
|
|
8
|
-
want to document using YARD.
|
|
9
|
-
|
|
10
|
-
## Modules
|
|
11
|
-
|
|
12
|
-
# Namespace for classes and modules that handle serving documentation over HTTP
|
|
13
|
-
# @since 0.6.0
|
|
14
|
-
|
|
15
|
-
## Classes
|
|
16
|
-
|
|
17
|
-
# Abstract base class for CLI utilities. Provides some helper methods for
|
|
18
|
-
# the option parser
|
|
19
|
-
#
|
|
20
|
-
# @author Full Name
|
|
21
|
-
# @abstract
|
|
22
|
-
# @since 0.6.0
|
|
23
|
-
# @attr [Types] attribute_name a full description of the attribute
|
|
24
|
-
# @attr_reader [Types] name description of a readonly attribute
|
|
25
|
-
# @attr_writer [Types] name description of writeonly attribute
|
|
26
|
-
# @deprecated Describe the reason or provide alt. references here
|
|
27
|
-
|
|
28
|
-
## Methods
|
|
29
|
-
|
|
30
|
-
# An alias to {Parser::SourceParser}'s parsing method
|
|
31
|
-
#
|
|
32
|
-
# @author Donovan Bray
|
|
33
|
-
#
|
|
34
|
-
# @see http://example.com Description of URL
|
|
35
|
-
# @see SomeOtherClass#method
|
|
36
|
-
#
|
|
37
|
-
# @deprecated Use {#my_new_method} instead of this method because
|
|
38
|
-
# it uses a library that is no longer supported in Ruby 1.9.
|
|
39
|
-
# The new method accepts the same parameters.
|
|
40
|
-
#
|
|
41
|
-
# @abstract
|
|
42
|
-
# @private
|
|
43
|
-
#
|
|
44
|
-
# @param opts [Hash] the options to create a message with.
|
|
45
|
-
# @option opts [String] :subject The subject
|
|
46
|
-
# @option opts [String] :from ('nobody') From address
|
|
47
|
-
# @option opts [String] :to Recipient email
|
|
48
|
-
# @option opts [String] :body ('') The email's body
|
|
49
|
-
#
|
|
50
|
-
# @param (see User#initialize)
|
|
51
|
-
# @param [OptionParser] opts the option parser object
|
|
52
|
-
# @param [Array<String>] args the arguments passed from input. This
|
|
53
|
-
# array will be modified.
|
|
54
|
-
# @param [Array<String, Symbol>] list the list of strings and symbols.
|
|
55
|
-
#
|
|
56
|
-
# The options parsed out of the commandline.
|
|
57
|
-
# Default options are:
|
|
58
|
-
# :format => :dot
|
|
59
|
-
#
|
|
60
|
-
# @example Reverse a string
|
|
61
|
-
# "mystring.reverse" #=> "gnirtsym"
|
|
62
|
-
#
|
|
63
|
-
# @example Parse a glob of files
|
|
64
|
-
# YARD.parse('lib/**/*.rb')
|
|
65
|
-
#
|
|
66
|
-
# @raise [ExceptionClass] description
|
|
67
|
-
#
|
|
68
|
-
# @return [optional, types, ...] description
|
|
69
|
-
# @return [true] always returns true
|
|
70
|
-
# @return [String, nil] the contents of our object or nil
|
|
71
|
-
# if the object has not been filled with data.
|
|
72
|
-
#
|
|
73
|
-
# We don't care about the "type" here:
|
|
74
|
-
# @return the object
|
|
75
|
-
#
|
|
76
|
-
# @return [String, #read] a string or object that responds to #read
|
|
77
|
-
# @return description here with no types
|
|
78
|
-
|
|
79
|
-
## Anywhere
|
|
80
|
-
|
|
81
|
-
# @todo Add support for Jabberwocky service
|
|
82
|
-
# There is an open source Jabberwocky library available
|
|
83
|
-
# at http://somesite.com that can be integrated easily
|
|
84
|
-
# into the project.
|
|
85
|
-
|
|
86
|
-
## Blocks
|
|
87
|
-
|
|
88
|
-
# for block {|a, b, c| ... }
|
|
89
|
-
# @yield [a, b, c] Description of block
|
|
90
|
-
#
|
|
91
|
-
# @yieldparam [optional, types, ...] argname description
|
|
92
|
-
# @yieldreturn [optional, types, ...] description
|
|
@@ -1,72 +0,0 @@
|
|
|
1
|
-
# For most projects, this workflow file will not need changing; you simply need
|
|
2
|
-
# to commit it to your repository.
|
|
3
|
-
#
|
|
4
|
-
# You may wish to alter this file to override the set of languages analyzed,
|
|
5
|
-
# or to provide custom queries or build logic.
|
|
6
|
-
#
|
|
7
|
-
# ******** NOTE ********
|
|
8
|
-
# We have attempted to detect the languages in your repository. Please check
|
|
9
|
-
# the `language` matrix defined below to confirm you have the correct set of
|
|
10
|
-
# supported CodeQL languages.
|
|
11
|
-
#
|
|
12
|
-
name: "CodeQL"
|
|
13
|
-
|
|
14
|
-
on:
|
|
15
|
-
push:
|
|
16
|
-
branches: [ master ]
|
|
17
|
-
pull_request:
|
|
18
|
-
# The branches below must be a subset of the branches above
|
|
19
|
-
branches: [ master ]
|
|
20
|
-
schedule:
|
|
21
|
-
- cron: '37 18 * * 5'
|
|
22
|
-
|
|
23
|
-
jobs:
|
|
24
|
-
analyze:
|
|
25
|
-
name: Analyze
|
|
26
|
-
runs-on: ubuntu-latest
|
|
27
|
-
permissions:
|
|
28
|
-
actions: read
|
|
29
|
-
contents: read
|
|
30
|
-
security-events: write
|
|
31
|
-
|
|
32
|
-
strategy:
|
|
33
|
-
fail-fast: false
|
|
34
|
-
matrix:
|
|
35
|
-
language: [ 'ruby' ]
|
|
36
|
-
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
|
|
37
|
-
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
|
|
38
|
-
|
|
39
|
-
steps:
|
|
40
|
-
- name: Checkout repository
|
|
41
|
-
uses: actions/checkout@v3
|
|
42
|
-
|
|
43
|
-
# Initializes the CodeQL tools for scanning.
|
|
44
|
-
- name: Initialize CodeQL
|
|
45
|
-
uses: github/codeql-action/init@v2
|
|
46
|
-
with:
|
|
47
|
-
languages: ${{ matrix.language }}
|
|
48
|
-
# If you wish to specify custom queries, you can do so here or in a config file.
|
|
49
|
-
# By default, queries listed here will override any specified in a config file.
|
|
50
|
-
# Prefix the list here with "+" to use these queries and those in the config file.
|
|
51
|
-
|
|
52
|
-
# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
|
|
53
|
-
# queries: security-extended,security-and-quality
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
|
|
57
|
-
# If this step fails, then you should remove it and run the build manually (see below)
|
|
58
|
-
- name: Autobuild
|
|
59
|
-
uses: github/codeql-action/autobuild@v2
|
|
60
|
-
|
|
61
|
-
# ℹ️ Command-line programs to run using the OS shell.
|
|
62
|
-
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
|
|
63
|
-
|
|
64
|
-
# If the Autobuild fails above, remove it and uncomment the following three lines.
|
|
65
|
-
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
|
|
66
|
-
|
|
67
|
-
# - run: |
|
|
68
|
-
# echo "Run, Build Application using script"
|
|
69
|
-
# ./location_of_script_within_repo/buildscript.sh
|
|
70
|
-
|
|
71
|
-
- name: Perform CodeQL Analysis
|
|
72
|
-
uses: github/codeql-action/analyze@v2
|