From 9b7f974ae06fe646504b68e7f30643346e04fe45 Mon Sep 17 00:00:00 2001 From: "Glenn Y. Rolland" Date: Wed, 5 Oct 2016 10:38:48 +0200 Subject: [PATCH] Add base structure for Gem. --- .gitignore | 15 ++-- .travis.yml | 4 + Gemfile | 10 ++- LICENSE.txt | 165 ++++++++++++++++++++++++++++++++++++++++++ Rakefile | 10 +++ aoidos.gemspec | 33 +++++++++ lib/aoidos.rb | 5 ++ lib/aoidos/version.rb | 3 + test/aoidos_test.rb | 11 +++ test/test_helper.rb | 4 + 10 files changed, 252 insertions(+), 8 deletions(-) create mode 100644 .travis.yml create mode 100644 LICENSE.txt create mode 100644 Rakefile create mode 100644 aoidos.gemspec create mode 100644 lib/aoidos.rb create mode 100644 lib/aoidos/version.rb create mode 100644 test/aoidos_test.rb create mode 100644 test/test_helper.rb diff --git a/.gitignore b/.gitignore index 2e67c55..12fa6fb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,13 @@ +/.bundle/ +/coverage/ +/doc/ +/Gemfile.lock Gemfile.lock -<<<<<<< HEAD -*.ods -*.ods# -======= .~lock* *.ods ->>>>>>> c64b0304619181fe571e4fe10831272881487e01 +*.ods# +/pkg/ +/spec/reports/ +/tmp/ +/_yardoc/ +/.yardoc diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..acf4004 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,4 @@ +language: ruby +rvm: + - 2.2.4 +before_install: gem install bundler -v 1.10.6 diff --git a/Gemfile b/Gemfile index 2ed7b52..2c66cf6 100644 --- a/Gemfile +++ b/Gemfile @@ -1,8 +1,12 @@ -# A sample Gemfile -source "https://rubygems.org" + +source 'https://rubygems.org' gem 'thor' -gem 'minedig', git: "https://github.com/siman-man/minedig" +gem 'minedig', git: 'https://github.com/siman-man/minedig' gem 'rspreadsheet' gem 'pry' gem 'semantic' + +# Specify your gem's dependencies in aoidos.gemspec +gemspec + diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..65c5ca8 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..d6c5113 --- /dev/null +++ b/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 diff --git a/aoidos.gemspec b/aoidos.gemspec new file mode 100644 index 0000000..7055deb --- /dev/null +++ b/aoidos.gemspec @@ -0,0 +1,33 @@ +# coding: utf-8 +lib = File.expand_path('../lib', __FILE__) +$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) +require 'aoidos/version' + +Gem::Specification.new do |spec| + spec.name = "aoidos" + spec.version = Aoidos::VERSION + spec.authors = ["Glenn Y. Rolland"] + spec.email = ["glenux@glenux.net"] + + spec.summary = %q{TODO: Write a short summary, because Rubygems requires one.} + spec.description = %q{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" + + # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or + # delete this section to allow pushing this gem to any host. + if spec.respond_to?(:metadata) + spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'" + else + raise "RubyGems 2.0 or newer is required to protect against public gem pushes." + end + + spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } + spec.bindir = "exe" + spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) } + spec.require_paths = ["lib"] + + spec.add_development_dependency "bundler", "~> 1.10" + spec.add_development_dependency "rake", "~> 10.0" + spec.add_development_dependency "minitest" +end diff --git a/lib/aoidos.rb b/lib/aoidos.rb new file mode 100644 index 0000000..e45e6b7 --- /dev/null +++ b/lib/aoidos.rb @@ -0,0 +1,5 @@ +require "aoidos/version" + +module Aoidos + # Your code goes here... +end diff --git a/lib/aoidos/version.rb b/lib/aoidos/version.rb new file mode 100644 index 0000000..a6470f8 --- /dev/null +++ b/lib/aoidos/version.rb @@ -0,0 +1,3 @@ +module Aoidos + VERSION = "0.1.0" +end diff --git a/test/aoidos_test.rb b/test/aoidos_test.rb new file mode 100644 index 0000000..5357264 --- /dev/null +++ b/test/aoidos_test.rb @@ -0,0 +1,11 @@ +require 'test_helper' + +class AoidosTest < Minitest::Test + def test_that_it_has_a_version_number + refute_nil ::Aoidos::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..d16d518 --- /dev/null +++ b/test/test_helper.rb @@ -0,0 +1,4 @@ +$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__) +require 'aoidos' + +require 'minitest/autorun'