From ec9bdf9be7f65c02224b6d5c0c7bb9d6eda26d9d Mon Sep 17 00:00:00 2001 From: Guillaume Dott Date: Tue, 12 Nov 2024 12:34:04 +0100 Subject: [PATCH] First commit --- .gitignore | 8 ++++++++ CHANGELOG.md | 5 +++++ Gemfile | 8 ++++++++ README.md | 31 +++++++++++++++++++++++++++++++ Rakefile | 4 ++++ bin/console | 11 +++++++++++ bin/setup | 8 ++++++++ lib/vat_rate.rb | 8 ++++++++ lib/vat_rate/version.rb | 5 +++++ sig/vat_rate.rbs | 4 ++++ vat_rate.gemspec | 40 ++++++++++++++++++++++++++++++++++++++++ 11 files changed, 132 insertions(+) create mode 100644 .gitignore create mode 100644 CHANGELOG.md create mode 100644 Gemfile create mode 100644 README.md create mode 100644 Rakefile create mode 100755 bin/console create mode 100755 bin/setup create mode 100644 lib/vat_rate.rb create mode 100644 lib/vat_rate/version.rb create mode 100644 sig/vat_rate.rbs create mode 100644 vat_rate.gemspec diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9106b2a --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +/.bundle/ +/.yardoc +/_yardoc/ +/coverage/ +/doc/ +/pkg/ +/spec/reports/ +/tmp/ diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..3118b57 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +## [Unreleased] + +## [0.1.0] - 2024-11-12 + +- Initial release diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..e4c6ad3 --- /dev/null +++ b/Gemfile @@ -0,0 +1,8 @@ +# frozen_string_literal: true + +source "https://rubygems.org" + +# Specify your gem's dependencies in vat_rate.gemspec +gemspec + +gem "rake", "~> 13.0" diff --git a/README.md b/README.md new file mode 100644 index 0000000..3acc6de --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# VatRate + +TODO: Delete this and the text below, and describe your gem + +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/vat_rate`. To experiment with that code, run `bin/console` for an interactive prompt. + +## Installation + +TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org. + +Install the gem and add to the application's Gemfile by executing: + + $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG + +If bundler is not being used to manage dependencies, install the gem by executing: + + $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG + +## Usage + +TODO: Write usage instructions here + +## Development + +After checking out the repo, run `bin/setup` to install dependencies. 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 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/[USERNAME]/vat_rate. diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..cd510a0 --- /dev/null +++ b/Rakefile @@ -0,0 +1,4 @@ +# frozen_string_literal: true + +require "bundler/gem_tasks" +task default: %i[] diff --git a/bin/console b/bin/console new file mode 100755 index 0000000..34ecbab --- /dev/null +++ b/bin/console @@ -0,0 +1,11 @@ +#!/usr/bin/env ruby +# frozen_string_literal: true + +require "bundler/setup" +require "vat_rate" + +# 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. + +require "irb" +IRB.start(__FILE__) diff --git a/bin/setup b/bin/setup new file mode 100755 index 0000000..dce67d8 --- /dev/null +++ b/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 diff --git a/lib/vat_rate.rb b/lib/vat_rate.rb new file mode 100644 index 0000000..3c744d1 --- /dev/null +++ b/lib/vat_rate.rb @@ -0,0 +1,8 @@ +# frozen_string_literal: true + +require_relative "vat_rate/version" + +module VatRate + class Error < StandardError; end + # Your code goes here... +end diff --git a/lib/vat_rate/version.rb b/lib/vat_rate/version.rb new file mode 100644 index 0000000..5499a87 --- /dev/null +++ b/lib/vat_rate/version.rb @@ -0,0 +1,5 @@ +# frozen_string_literal: true + +module VatRate + VERSION = "0.1.0" +end diff --git a/sig/vat_rate.rbs b/sig/vat_rate.rbs new file mode 100644 index 0000000..1a68567 --- /dev/null +++ b/sig/vat_rate.rbs @@ -0,0 +1,4 @@ +module VatRate + VERSION: String + # See the writing guide of rbs: https://github.com/ruby/rbs#guides +end diff --git a/vat_rate.gemspec b/vat_rate.gemspec new file mode 100644 index 0000000..0b7de77 --- /dev/null +++ b/vat_rate.gemspec @@ -0,0 +1,40 @@ +# frozen_string_literal: true + +require_relative "lib/vat_rate/version" + +Gem::Specification.new do |spec| + spec.name = "vat_rate" + spec.version = VatRate::VERSION + spec.authors = ["Guillaume Dott"] + spec.email = ["guillaume+github@dott.fr"] + + spec.summary = "TODO: Write a short summary, because RubyGems requires one." + spec.description = "TODO: Write a longer description or delete this line." + spec.homepage = "TODO: Put your gem's website or public repo URL here." + spec.required_ruby_version = ">= 3.0.0" + + spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'" + + spec.metadata["homepage_uri"] = spec.homepage + spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here." + spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here." + + # 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. + gemspec = File.basename(__FILE__) + spec.files = IO.popen(%w[git ls-files -z], chdir: __dir__, err: IO::NULL) do |ls| + ls.readlines("\x0", chomp: true).reject do |f| + (f == gemspec) || + f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile]) + end + end + spec.bindir = "exe" + spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) } + spec.require_paths = ["lib"] + + # Uncomment to register a new dependency of your gem + # spec.add_dependency "example-gem", "~> 1.0" + + # For more information and examples about making a new gem, check out our + # guide at: https://bundler.io/guides/creating_gem.html +end