diff options
| -rw-r--r-- | .gitignore | 8 | ||||
| -rw-r--r-- | Gemfile | 6 | ||||
| -rw-r--r-- | LICENSE.txt | 21 | ||||
| -rw-r--r-- | README.md | 40 | ||||
| -rw-r--r-- | Rakefile | 2 | ||||
| -rwxr-xr-x | bin/console | 14 | ||||
| -rwxr-xr-x | bin/setup | 8 | ||||
| -rw-r--r-- | felpack-example.gemspec | 29 | ||||
| -rw-r--r-- | lib/felpack/example.rb | 8 | ||||
| -rw-r--r-- | lib/felpack/example/tasks/install.rake | 7 | ||||
| -rw-r--r-- | lib/felpack/example/tasks/update.rake | 7 | ||||
| -rw-r--r-- | lib/felpack/example/version.rb | 5 |
12 files changed, 155 insertions, 0 deletions
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/ @@ -0,0 +1,6 @@ +source "https://rubygems.org" + +# Specify your gem's dependencies in felpack-example.gemspec +gemspec + +gem "rake", "~> 12.0" diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..82abdd9 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2021 realtradam + +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..ef6c8e8 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# Felpack::Example + +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/felpack/example`. To experiment with that code, run `bin/console` for an interactive prompt. + +TODO: Delete this and the text above, and describe your gem + +## Installation + +Add this line to your application's Gemfile: + +```ruby +gem 'felpack-example' +``` + +And then execute: + + $ bundle install + +Or install it yourself as: + + $ gem install felpack-example + +## 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 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/[USERNAME]/felpack-example. + + +## 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..43022f7 --- /dev/null +++ b/Rakefile @@ -0,0 +1,2 @@ +require "bundler/gem_tasks" +task :default => :spec diff --git a/bin/console b/bin/console new file mode 100755 index 0000000..55ab56c --- /dev/null +++ b/bin/console @@ -0,0 +1,14 @@ +#!/usr/bin/env ruby + +require "bundler/setup" +require "felpack/example" + +# 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/felpack-example.gemspec b/felpack-example.gemspec new file mode 100644 index 0000000..435d57a --- /dev/null +++ b/felpack-example.gemspec @@ -0,0 +1,29 @@ +require_relative 'lib/felpack/example/version' + +Gem::Specification.new do |spec| + spec.name = "felpack-example" + spec.version = Felpack::Example::VERSION + spec.authors = ["_Tradam"] + spec.email = ["[email protected]"] + + spec.summary = %q{An example of what a FelPack is structured like} + #spec.description = %q{TODO: Write a longer description or delete this line.} + spec.homepage = "https://github.com/realtradam/felpack-example" + spec.license = "MIT" + spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0") + + #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'" + + spec.metadata["homepage_uri"] = spec.homepage + spec.metadata["source_code_uri"] = "https://github.com/realtradam/felpack-example" + #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(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"] +end diff --git a/lib/felpack/example.rb b/lib/felpack/example.rb new file mode 100644 index 0000000..c1c98c0 --- /dev/null +++ b/lib/felpack/example.rb @@ -0,0 +1,8 @@ +require "felpack/example/version" + +module Felpack + module Example + class Error < StandardError; end + # Your code goes here... + end +end diff --git a/lib/felpack/example/tasks/install.rake b/lib/felpack/example/tasks/install.rake new file mode 100644 index 0000000..ed078b1 --- /dev/null +++ b/lib/felpack/example/tasks/install.rake @@ -0,0 +1,7 @@ + +namespace :felinstall do + desc 'Install the Example FelPackage' + task :example do + puts 'The FelPack was pretend-installed!' + end +end diff --git a/lib/felpack/example/tasks/update.rake b/lib/felpack/example/tasks/update.rake new file mode 100644 index 0000000..0739bd6 --- /dev/null +++ b/lib/felpack/example/tasks/update.rake @@ -0,0 +1,7 @@ + +namespace :felupdate do + desc 'Update the Exmaple FelPackage' + task :example do + puts 'The FelPack was pretend-updated!' + end +end diff --git a/lib/felpack/example/version.rb b/lib/felpack/example/version.rb new file mode 100644 index 0000000..89edfab --- /dev/null +++ b/lib/felpack/example/version.rb @@ -0,0 +1,5 @@ +module Felpack + module Example + VERSION = "0.1.0" + end +end |
