gemwork 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d3241df9423a54841f11171d2fbeff4bb63b22085bc187a18fedae95b74ee2f
+  data.tar.gz: 7a5dea7187011408054ec03e82ec39613db139d40187db044f115a35a3b65133
+SHA512:
+  metadata.gz: d0f5e9c142694babd902734ef36ccdee43439ca13a79b3d276a488136e42dfa1a8a2dd6ea2dc38ce727937bbede0e5c94d1e0da04b0508876be932af8cf5e9dd
+  data.tar.gz: c996bc46e4a8d3b96daeb73d4d3c8ccbf9905267dc3f238de1d2cc3d4d55b500d08945591728e7065a2bbd8a50892e54e568f2d22a7c4544a20f04ca46b06aa9

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.1] - 2023-11-24
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Paul DobbinSchmaltz
+
+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,118 @@
+# Gemwork
+
+Gemwork is an abstract framework used by [pdobb](https://github.com/pdobb)'s Ruby Gems.
+
+## Installation
+
+Add this line to your `my_gem.gemspec` file:
+
+```ruby
+spec.add_development_dependency "gemwork"
+```
+
+And then execute:
+
+```bash
+bundle
+
+# OR
+
+bin/setup
+```
+
+## Rake Integration
+
+Gemwork provides a number of additional Rake tasks that can be integrated into your project.
+
+Create file: `./rakelib/gemwork.rake`
+(If the `rakelib` directory doesn't exist, create it at the project root.)
+
+```ruby
+# frozen_string_literal: true
+
+# Load additional tasks defined by Gemwork.
+Gem::Specification.find_by_name("gemwork").tap do |gemspec|
+  Rake.load_rakefile("#{gemspec.gem_dir}/lib/tasks/Rakefile")
+end
+```
+
+Running `rake -T` after this will reveal the additional tasks defined by Gemwork just as if they were defined within your project.
+
+## Rubocop Integration
+### Simple Usage
+
+Add the following to the `.rubocop.yml` file in your gem:
+
+```yaml
+# .rubocop.yml
+
+inherit_gem:
+  gemwork: lib/rubocop/.rubocop.yml
+```
+
+### Advanced Usage
+
+The above (simple usage) will automatically includes all RuboCop configuration settings defined in Gemwork. You can, however, require individual cop definitions piecemeal:
+
+```yaml
+# .rubocop.yml
+
+# Load Rubocop plugins.
+require:
+  - rubocop-rake
+  - rubocop-minitest
+  - rubocop-performance
+
+# Load Cops configuration by Department.
+inherit_gem:
+  gemwork:
+    - lib/rubocop/all_cops.yml
+    - lib/rubocop/gemspec.yml
+    - lib/rubocop/layout.yml
+    - lib/rubocop/lint.yml
+    - lib/rubocop/metrics.yml
+    - lib/rubocop/naming.yml
+    - lib/rubocop/style.yml
+```
+
+See also: [RuboCop's Configuration Guide on Inheritance](https://github.com/rubocop/rubocop/blob/master/docs/modules/ROOT/pages/configuration.adoc#inheriting-configuration-from-a-dependency-gem).
+
+## Development
+
+Development of Gemwork often requires making updates to its code and then testing them in another child gem that uses Gemwork.
+
+Even if the child gem already has the `gemwork` gem installed from RubyGems, local changes to Gemwork can be compiled and installed as a local gem, which the child gem will then immediately utilize. To facilitate this, it is recommended to add this compile/local-install step to the child gem's `bin/setup` executable:
+
+```bash
+# ./bin/setup for your child gem:
+
+# ...
+
+# Recompile and install Gemwork locally.
+( cd ~/dev/gemwork && rake install:local )
+
+# The above code should be placed above this line in your bin/setup:
+bundle install
+
+# ...
+```
+
+### Releases
+
+To release a new version of Gemwork to RubyGems:
+
+1. Update the version number in `version.rb`
+2. Update `CHANGELOG.md`
+3. Run `rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pdobb/gemwork. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/pdobb/gemwork/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Gemwork project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pdobb/gemwork/blob/master/CODE_OF_CONDUCT.md).

data/lib/gemwork/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Gemwork
+  VERSION = "0.1.0"
+end

data/lib/gemwork.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "version"
+
+# Gemwork is the top-level namespace/module for this gem.
+module Gemwork
+end

data/lib/reek/.reek.yml

@@ -0,0 +1,18 @@
+# See: https://github.com/troessner/reek#configuration-options
+
+detectors:
+  Attribute:
+    enabled: false
+  DuplicateMethodCall:
+    exclude:
+      - "self.test"
+  TooManyStatements:
+    exclude:
+      - "self.test"
+  UncommunicativeVariableName:
+    exclude:
+      - "self.test"
+
+exclude_paths:
+  - script
+  - test

data/lib/rubocop/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from:
+  - ./all_cops.yml
+  - ./gemspec.yml
+  - ./layout.yml
+  - ./lint.yml
+  - ./metrics.yml
+  - ./naming.yml
+  - ./style.yml

data/lib/rubocop/all_cops.yml

@@ -0,0 +1,15 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: true
+  NewCops: enable
+  TargetRubyVersion: 2.7
+  UseCache: true
+  Exclude:
+    # Rubocop Defaults
+    - "node_modules/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+    - ".git/**/*"
+    # Custom additions
+    - "script/**/*"

data/lib/rubocop/gemspec.yml

@@ -0,0 +1,8 @@
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: true
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+Gemspec/RequireMFA:
+  Enabled: true

data/lib/rubocop/layout.yml

@@ -0,0 +1,57 @@
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: true
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/FirstArgumentIndentation:
+  EnforcedStyle: consistent_relative_to_receiver
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstParameterIndentation:
+  Enabled: false # Revisit if more settings become available.
+
+Layout/LineContinuationSpacing:
+  EnforcedStyle: no_space
+
+Layout/LineEndStringConcatenationIndentation:
+  EnforcedStyle: aligned
+
+Layout/LineLength:
+  Max: 80
+  Exclude:
+    - "*.gemspec"
+  AllowedPatterns:
+    # YARD doc `@example` output.
+    - !ruby/regexp /\A *#   \# => /
+    - !ruby/regexp /\A *#   =/
+
+Layout/MultilineAssignmentLayout:
+  Enabled: true
+  SupportedTypes:
+    - block
+    - case
+    - class
+    - if
+    # - kwbegin
+    - module
+
+Layout/MultilineMethodCallBraceLayout:
+  EnforcedStyle: same_line
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+Layout/MultilineMethodDefinitionBraceLayout:
+  EnforcedStyle: same_line
+
+Layout/MultilineOperationIndentation:
+  Enabled: false # Waiting for e.g. `indented_relative_to_receiver`.

data/lib/rubocop/lint.yml

@@ -0,0 +1,8 @@
+# Lint/AmbiguousOperator:
+#   Enabled: false # Conflicts with other rules.
+
+# Lint/AmbiguousRegexpLiteral:
+#   Enabled: false # Conflicts with other rules.
+
+Lint/Void:
+  CheckForMethodsWithNoSideEffects: true

data/lib/rubocop/metrics.yml

@@ -0,0 +1,28 @@
+Metrics/BlockLength:
+  AllowedMethods:
+    - context # Tests
+    - describe # Tests
+    - ips # Benchmarking
+    - new
+
+Metrics/ClassLength:
+  CountAsOne:
+    - array
+    - heredoc
+    - method_call
+  Exclude:
+    - "test/**/*"
+
+Metrics/MethodLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+    - method_call
+
+Metrics/ModuleLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+    - method_call

data/lib/rubocop/naming.yml

@@ -0,0 +1,7 @@
+Naming/MethodParameterName:
+  AllowedNames:
+    - a
+    - b
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: ex

data/lib/rubocop/style.yml

@@ -0,0 +1,105 @@
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+  AllowBracesOnProceduralOneLiners: true
+  FunctionalMethods:
+    # Minitest Spec DSL. (Rubocop defaults.)
+    - let
+    - let!
+    - subject
+    - watch
+    # Overrides (Defaulted to Procedural by Rubocop.)
+    - tap
+    # MuchStub
+    - call
+    - on_call
+    - spy
+    # - tap (Already listed above.)
+    - tap_on_call
+    - with
+  ProceduralMethods: # Defining this just to remove `tap` from the list.
+    - benchmark
+    - bm
+    - bmbm
+    - create
+    - each_with_object
+    - measure
+    - new
+    - realtime
+    # - tap (Remove from Rubocop defaults.)
+    - with_object
+
+Style/ClassAndModuleChildren:
+  AutoCorrect: true
+  EnforcedStyle: compact
+  Exclude:
+    - "test/**/*"
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    find_all: select
+    detect: detect
+    inject: inject
+
+Style/Documentation:
+  Exclude:
+    - "test/**/*"
+
+Style/EmptyElse:
+  Enabled: false # Including a comment in an empty else block shows intent.
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/ExpandPathArguments:
+  Exclude:
+    - "*.gemspec"
+
+Style/FormatString:
+  Enabled: false # % notation with an Array just reads better sometimes.
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/LambdaCall:
+  Enabled: false # Allow ServiceObject.(*). Only use on classes, not instances.
+
+Style/NumericPredicate:
+  AutoCorrect: true
+
+Style/OpenStructUse:
+  Exclude:
+    - "test/**/*"
+
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+
+Style/ReturnNil:
+  Enabled: true
+
+Style/StringMethods:
+  Enabled: true
+
+Style/SingleLineMethods:
+  Exclude:
+    - "test/**/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/lib/tasks/Rakefile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# FIXME: How to do relative path loading (from a child gem context)?
+spec = Gem::Specification.find_by_name("gemwork")
+Dir.glob("#{spec.gem_dir}/lib/tasks/*.rake").each { |r| load r }
+
+task :default do
+  run_tasks(%i[
+    test
+    rubocop
+    reek
+    yard
+  ])
+end
+
+def run_tasks(tasks)
+  tasks.each_with_index do |name, index|
+    annotate_run(name) do
+      Rake::Task[name].invoke
+    end
+
+    puts unless index.next == tasks.size
+  end
+end
+
+def annotate_run(name)
+  puts "= Running #{name} #{"=" * (71 - name.size)}\n"
+  yield
+  puts "= Done #{"=" * 75}"
+end

data/lib/tasks/reek.rake

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "reek/rake/task"
+
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = false
+end

data/lib/tasks/rubocop.rake

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new do |t|
+  t.fail_on_error = false
+end

data/lib/tasks/test.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end

data/lib/tasks/yard.rake

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "yard"
+
+YARD::Rake::YardocTask.new do |t|
+  t.stats_options = ["--list-undoc"]
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: gemwork
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul DobbinSchmaltz
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gemwork is an abstract framework used by pdobb's Ruby Gems.
+email:
+- p.dobbinschmaltz@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/gemwork.rb
+- lib/gemwork/version.rb
+- lib/reek/.reek.yml
+- lib/rubocop/.rubocop.yml
+- lib/rubocop/all_cops.yml
+- lib/rubocop/gemspec.yml
+- lib/rubocop/layout.yml
+- lib/rubocop/lint.yml
+- lib/rubocop/metrics.yml
+- lib/rubocop/naming.yml
+- lib/rubocop/style.yml
+- lib/tasks/Rakefile
+- lib/tasks/reek.rake
+- lib/tasks/rubocop.rake
+- lib/tasks/test.rake
+- lib/tasks/yard.rake
+homepage: https://github.com/pdobb/gemwork
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/pdobb/gemwork/issues
+  changelog_uri: https://github.com/pdobb/gemwork/releases
+  source_code_uri: https://github.com/pdobb/gemwork
+  homepage_uri: https://github.com/pdobb/gemwork
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Common gem framework code used by pdobb's Ruby Gems.
+test_files: []