hello-world-rubygems 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 129955ccc3a16a767ca37a465b581d6901853fe550cc3a8301eac9493f90725c
+  data.tar.gz: a2753581d4ad59b56f7d47308cc90874b03c1100a5ae8838fccf4a2ad845ef11
+SHA512:
+  metadata.gz: 1a2514d0e485e550655964a1fa7eb58b554ca6534bbf39dc3d71b971270baa510b099babb0e4d4ff9ec7b5a742ad3fff68a84b78d1dd4d458eea834845cb4754
+  data.tar.gz: 1389f847cad77d163b23260c2029f55731d06fa3312c3306d05bb53ae90e189d8d0aaafdb1acd0ef59a48f5c53bcb364f028304d368009b6ce57d52644a3128f

data/.github/workflows/ci.yml

@@ -0,0 +1,72 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  linting:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.6
+    - name: Install rubocop
+      run: gem install rubocop
+    - name: Install dependencies
+      run: bundle install --retry 3
+    - name: Run Linter
+      run: bundle exec rubocop
+      
+  unittest:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install --retry 3
+    - name: Run tests
+      run: bundle exec rake test
+    
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2    
+      - name: Set up Ruby
+      # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+      # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      # uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+        with:
+          ruby-version: 2.6
+      - name: Install simplecov
+        run: gem install simplecov        
+      - name: Install dependencies
+        run: bundle install --retry 3
+      - name: Test & publish code coverage to codeclimate
+        uses: paambaati/codeclimate-action@v2.6.0
+        env:
+          # Set CC_TEST_REPORTER_ID as secret of your repo
+          CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
+        with:
+          coverageCommand: bundle exec rake

data/.gitignore

@@ -0,0 +1,14 @@
+# Do NOT put your Gemfile.lock under VC for gems (https://stackoverflow.com/questions/4151495/should-gemfile-lock-be-included-in-gitignore)
+Gemfile.lock
+
+# Tests
+/coverage/
+/spec/reports/
+
+# Cache and Temp files
+/.bundle/
+/.yardoc
+/_yardoc/
+/doc/
+/pkg/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,41 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+    - "*.gemspec"
+    - "gemfiles/*"
+    - gems/**/*
+    - node_modules/**/*
+    - vendor/bundle/**/*
+    - Rakefile
+    - Gemfile
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: false
+
+Lint/RaiseException:
+  Enabled: false
+Lint/ScriptPermission:
+  Enabled: false
+Lint/StructNewOverride:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Style/ExponentialNotation:
+  Enabled: false  
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/WordArray:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.0.2

data/.whitesource

@@ -0,0 +1,8 @@
+{
+  "checkRunSettings": {
+    "vulnerableCheckRunConclusionLevel": "failure"
+  },
+  "issueSettings": {
+    "minSeverityLevel": "LOW"
+  }
+}

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+The [Releases](https://github.com/n13org/hello-world-rubygems/releases) of the `hello world`.
+
+1. Create the project
+1. Update Metadata of the gem spec
+1. Fix default unittests
+1. Add GitHub Action "rake test" as CI
+1. Add Visual Code workspace
+1. Add RuboCop as Code Style Linter
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hello-world-rubygems.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 n13.org
+
+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,41 @@
+# Hello::World::Rubygems
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/hello/world/rubygems`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+Here is the step by step [Blog Post][Blog Post] related to that ruby gem package.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hello-world-rubygems'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hello-world-rubygems
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/n13org/hello-world-rubygems.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[Blog Post]: https://notes.kargware.com/2020/05/05/My-first-gem-on-rubygems.org

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'hello/world/rubygems'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hello-world-rubygems.code-workspace

@@ -0,0 +1,8 @@
+{
+	"folders": [
+		{
+			"path": "."
+		}
+	],
+	"settings": {}
+}

data/hello-world-rubygems.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hello/world/rubygems/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hello-world-rubygems"
+  spec.version       = Hello::World::Rubygems::VERSION
+  spec.authors       = ["n13-org", "KargWare"]
+  spec.email         = ["rubygems.org@n13.org"]
+
+  spec.summary       = %q{A hello world gem project for rubygems.org}
+  spec.description   = %q{A `hello-world` gem, written in ruby, including tests (minitest), Rakefile and GitHub Actions to publish a package to rubygems.org}
+  spec.homepage      = "https://github.com/n13org/hello-world-rubygems"
+  spec.license       = "MIT"
+  
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/n13org/hello-world-rubygems"
+  spec.metadata["changelog_uri"] = "https://github.com/n13org/hello-world-rubygems/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 12.3.3"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rubocop", "~> 0.82.0"
+  spec.add_development_dependency "simplecov", "~> 0.18.5"
+end

data/lib/hello/world/rubygems.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'hello/world/rubygems/version'
+
+module Hello
+  module World
+    module Rubygems
+      class Error < StandardError; end
+      # Your code goes here...
+    end
+  end
+end

data/lib/hello/world/rubygems/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Hello
+  module World
+    module Rubygems
+      VERSION = '0.1.1'
+    end
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: hello-world-rubygems
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- n13-org
+- KargWare
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+description: A `hello-world` gem, written in ruby, including tests (minitest), Rakefile
+  and GitHub Actions to publish a package to rubygems.org
+email:
+- rubygems.org@n13.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".whitesource"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hello-world-rubygems.code-workspace
+- hello-world-rubygems.gemspec
+- lib/hello/world/rubygems.rb
+- lib/hello/world/rubygems/version.rb
+homepage: https://github.com/n13org/hello-world-rubygems
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/n13org/hello-world-rubygems
+  source_code_uri: https://github.com/n13org/hello-world-rubygems
+  changelog_uri: https://github.com/n13org/hello-world-rubygems/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: A hello world gem project for rubygems.org
+test_files: []