From de7de8f35c6f2e4725027f703eda3e9231e97ae5 Mon Sep 17 00:00:00 2001 From: Guillaume Dott Date: Fri, 14 Oct 2022 10:59:53 +0200 Subject: [PATCH] First commit --- .gitignore | 8 +++++++ CHANGELOG.md | 5 ++++ Gemfile | 10 ++++++++ LICENSE.txt | 21 +++++++++++++++++ README.md | 33 ++++++++++++++++++++++++++ Rakefile | 12 ++++++++++ bin/console | 15 ++++++++++++ bin/setup | 8 +++++++ fourmi-prawn-utils.gemspec | 39 +++++++++++++++++++++++++++++++ lib/fourmi/prawn/utils.rb | 12 ++++++++++ lib/fourmi/prawn/utils/version.rb | 9 +++++++ sig/fourmi/prawn/utils.rbs | 8 +++++++ test/fourmi/prawn/test_utils.rb | 13 +++++++++++ test/test_helper.rb | 6 +++++ 14 files changed, 199 insertions(+) create mode 100644 .gitignore create mode 100644 CHANGELOG.md create mode 100644 Gemfile create mode 100644 LICENSE.txt create mode 100644 README.md create mode 100644 Rakefile create mode 100755 bin/console create mode 100755 bin/setup create mode 100644 fourmi-prawn-utils.gemspec create mode 100644 lib/fourmi/prawn/utils.rb create mode 100644 lib/fourmi/prawn/utils/version.rb create mode 100644 sig/fourmi/prawn/utils.rbs create mode 100644 test/fourmi/prawn/test_utils.rb create mode 100644 test/test_helper.rb 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..a2d1554 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +## [Unreleased] + +## [0.1.0] - 2022-10-14 + +- Initial release diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..2d89e00 --- /dev/null +++ b/Gemfile @@ -0,0 +1,10 @@ +# frozen_string_literal: true + +source "https://rubygems.org" + +# Specify your gem's dependencies in fourmi-prawn-utils.gemspec +gemspec + +gem "rake", "~> 13.0" + +gem "minitest", "~> 5.0" diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..2b1d8c8 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2022 Guillaume Dott + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..b4c8448 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# Fourmi::Prawn::Utils + +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/fourmi/prawn/utils`. To experiment with that code, run `bin/console` for an interactive prompt. + +TODO: Delete this and the text above, and describe your gem + +## Installation + +Install the gem and add to the application's Gemfile by executing: + + $ bundle add fourmi-prawn-utils + +If bundler is not being used to manage dependencies, install the gem by executing: + + $ gem install fourmi-prawn-utils + +## 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 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]/fourmi-prawn-utils. + +## License + +The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..b3021e5 --- /dev/null +++ b/Rakefile @@ -0,0 +1,12 @@ +# frozen_string_literal: true + +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 diff --git a/bin/console b/bin/console new file mode 100755 index 0000000..eedf12b --- /dev/null +++ b/bin/console @@ -0,0 +1,15 @@ +#!/usr/bin/env ruby +# frozen_string_literal: true + +require "bundler/setup" +require "fourmi/prawn/utils" + +# 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__) 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/fourmi-prawn-utils.gemspec b/fourmi-prawn-utils.gemspec new file mode 100644 index 0000000..730ba33 --- /dev/null +++ b/fourmi-prawn-utils.gemspec @@ -0,0 +1,39 @@ +# frozen_string_literal: true + +require_relative "lib/fourmi/prawn/utils/version" + +Gem::Specification.new do |spec| + spec.name = "fourmi-prawn-utils" + spec.version = Fourmi::Prawn::Utils::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.license = "MIT" + spec.required_ruby_version = ">= 2.6.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. + spec.files = Dir.chdir(__dir__) do + `git ls-files -z`.split("\x0").reject do |f| + (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)}) + 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 diff --git a/lib/fourmi/prawn/utils.rb b/lib/fourmi/prawn/utils.rb new file mode 100644 index 0000000..1d1ad71 --- /dev/null +++ b/lib/fourmi/prawn/utils.rb @@ -0,0 +1,12 @@ +# frozen_string_literal: true + +require_relative "utils/version" + +module Fourmi + module Prawn + module Utils + class Error < StandardError; end + # Your code goes here... + end + end +end diff --git a/lib/fourmi/prawn/utils/version.rb b/lib/fourmi/prawn/utils/version.rb new file mode 100644 index 0000000..3766bda --- /dev/null +++ b/lib/fourmi/prawn/utils/version.rb @@ -0,0 +1,9 @@ +# frozen_string_literal: true + +module Fourmi + module Prawn + module Utils + VERSION = "0.1.0" + end + end +end diff --git a/sig/fourmi/prawn/utils.rbs b/sig/fourmi/prawn/utils.rbs new file mode 100644 index 0000000..914a2c5 --- /dev/null +++ b/sig/fourmi/prawn/utils.rbs @@ -0,0 +1,8 @@ +module Fourmi + module Prawn + module Utils + VERSION: String + # See the writing guide of rbs: https://github.com/ruby/rbs#guides + end + end +end diff --git a/test/fourmi/prawn/test_utils.rb b/test/fourmi/prawn/test_utils.rb new file mode 100644 index 0000000..39def67 --- /dev/null +++ b/test/fourmi/prawn/test_utils.rb @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +require "test_helper" + +class Fourmi::Prawn::TestUtils < Minitest::Test + def test_that_it_has_a_version_number + refute_nil ::Fourmi::Prawn::Utils::VERSION + end + + def test_it_does_something_useful + assert false + end +end diff --git a/test/test_helper.rb b/test/test_helper.rb new file mode 100644 index 0000000..dd42233 --- /dev/null +++ b/test/test_helper.rb @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +$LOAD_PATH.unshift File.expand_path("../lib", __dir__) +require "fourmi/prawn/utils" + +require "minitest/autorun"