Skip to content

Commit

Permalink
Created the project.
Browse files Browse the repository at this point in the history
  • Loading branch information
artob committed May 4, 2020
0 parents commit 360d2c8
Show file tree
Hide file tree
Showing 29 changed files with 309 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. Chrome, Safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, Safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is.
For example: I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you would like to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features
you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
1 change: 1 addition & 0 deletions .github/codeowners
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# See: https://help.github.com/en/articles/about-code-owners
3 changes: 3 additions & 0 deletions .github/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<!--- See: https://help.github.com/en/articles/setting-guidelines-for-repository-contributors --->

# How to contribute
1 change: 1 addition & 0 deletions .github/funding.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# See: https://help.github.com/en/articles/displaying-a-sponsor-button-in-your-repository
Empty file.
3 changes: 3 additions & 0 deletions .github/security.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<!--- See: https://help.github.com/en/articles/adding-a-security-policy-to-your-repository --->

# How to report a security vulnerability
3 changes: 3 additions & 0 deletions .github/support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<!--- See: https://help.github.com/en/articles/adding-support-resources-to-your-project --->

# How to get support
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# macOS
.DS_Store

# Editor backup files
*~

# Ruby artifacts
.bundle
.yardoc
Gemfile.lock
*.gem
1 change: 1 addition & 0 deletions .rspec
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
--require spec_helper
12 changes: 12 additions & 0 deletions .yardopts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
--output-dir doc/yard
--protected
--no-private
--hide-void-return
--markup markdown
--readme README.md
-
AUTHORS
CHANGES.md
CREDITS.md
UNLICENSE
VERSION
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* Arto Bendiken <[email protected]>
7 changes: 7 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Changelog
=========

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
2 changes: 2 additions & 0 deletions CREDITS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Credits
=======
11 changes: 11 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
source 'https://rubygems.org'
gemspec

# https://rubygems.org/gems/ffi
gem 'ffi', '~> 1.12', '>= 1.12.2'

group :development do
gem 'rake'
gem 'rspec'
gem 'yard'
end
Empty file added README.md
Empty file.
2 changes: 2 additions & 0 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
To-Dos
======
24 changes: 24 additions & 0 deletions UNLICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

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 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.

For more information, please refer to <https://unlicense.org/>
1 change: 1 addition & 0 deletions VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
0.0.0
Empty file added bin/.gitkeep
Empty file.
2 changes: 2 additions & 0 deletions doc/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
rdoc
yard
Empty file added doc/examples/.gitkeep
Empty file.
Empty file added etc/.gitkeep
Empty file.
Empty file added lib/.gitkeep
Empty file.
3 changes: 3 additions & 0 deletions lib/openxr.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# This is free and unencumbered software released into the public domain.

require_relative 'openxr/version'
21 changes: 21 additions & 0 deletions lib/openxr/version.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# This is free and unencumbered software released into the public domain.

module OpenXR
module VERSION
FILE = File.expand_path('../../VERSION', __dir__).freeze
STRING = File.read(FILE).chomp.freeze
MAJOR, MINOR, TINY, EXTRA = STRING.split('.').map(&:to_i).freeze

##
# @return [String]
def self.to_s() STRING end

##
# @return [String]
def self.to_str() STRING end

##
# @return [Array(Integer, Integer, Integer)]
def self.to_a() [MAJOR, MINOR, TINY].freeze end
end # VERSION
end # OpenXR
38 changes: 38 additions & 0 deletions openxr.gemspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
Gem::Specification.new do |gem|
gem.version = File.read('VERSION').chomp
gem.date = File.mtime('VERSION').strftime('%Y-%m-%d')

gem.name = 'openxr'
gem.homepage = 'https://github.com/dryruby/openxr.rb'
gem.license = 'Unlicense'
gem.summary = 'OpenXR bindings for Ruby.'
gem.description = gem.summary

gem.author = 'Arto Bendiken'
gem.email = '[email protected]'

gem.metadata = {
'bug_tracker_uri' => 'https://github.com/dryruby/openxr.rb/issues',
'changelog_uri' => 'https://github.com/dryruby/openxr.rb/blob/master/CHANGES.md',
'documentation_uri' => 'https://www.rubydoc.info/github/dryruby/openxr.rb/master',
'homepage_uri' => gem.homepage,
'source_code_uri' => 'https://github.com/dryruby/openxr.rb',
}

gem.platform = Gem::Platform::RUBY
gem.files = %w(AUTHORS CHANGES.md CREDITS.md README.md UNLICENSE VERSION) + Dir.glob('lib/**/*.rb')
gem.bindir = %q(bin)
gem.executables = %w()
gem.require_paths = %w(lib)
gem.extensions = %w()
gem.test_files = %w()

gem.required_ruby_version = '>= 2.7.0'
gem.required_rubygems_version = '>= 3.1.2' # Ruby 2.7.0
gem.requirements = []
gem.add_development_dependency 'rake', '>= 13'
gem.add_development_dependency 'rspec', '>= 3.9'
gem.add_development_dependency 'yard' , '>= 0.9'
gem.add_runtime_dependency 'ffi', '~> 1.12'
gem.post_install_message = nil
end
Empty file added spec/.gitkeep
Empty file.
102 changes: 102 additions & 0 deletions spec/spec_helper.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# This is free and unencumbered software released into the public domain.

# This file was generated by the `rspec --init` command. Conventionally, all
# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
# The generated `.rspec` file contains `--require spec_helper` which will cause
# this file to always be loaded, without a need to explicitly require it in any
# files.
#
# Given that it is always loaded, you are encouraged to keep this file as
# light-weight as possible. Requiring heavyweight dependencies from this file
# will add to the boot time of your test suite on EVERY test run, even for an
# individual file that may not need all of that loaded. Instead, consider making
# a separate helper file that requires the additional dependencies and performs
# the additional setup, and require it from the spec files that actually need
# it.
#
# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
RSpec.configure do |config|
# rspec-expectations config goes here. You can use an alternate
# assertion/expectation library such as wrong or the stdlib/minitest
# assertions if you prefer.
config.expect_with :rspec do |expectations|
# This option will default to `true` in RSpec 4. It makes the `description`
# and `failure_message` of custom matchers include text for helper methods
# defined using `chain`, e.g.:
# be_bigger_than(2).and_smaller_than(4).description
# # => "be bigger than 2 and smaller than 4"
# ...rather than:
# # => "be bigger than 2"
expectations.include_chain_clauses_in_custom_matcher_descriptions = true
end

# rspec-mocks config goes here. You can use an alternate test double
# library (such as bogus or mocha) by changing the `mock_with` option here.
config.mock_with :rspec do |mocks|
# Prevents you from mocking or stubbing a method that does not exist on
# a real object. This is generally recommended, and will default to
# `true` in RSpec 4.
mocks.verify_partial_doubles = true
end

# This option will default to `:apply_to_host_groups` in RSpec 4 (and will
# have no way to turn it off -- the option exists only for backwards
# compatibility in RSpec 3). It causes shared context metadata to be
# inherited by the metadata hash of host groups and examples, rather than
# triggering implicit auto-inclusion in groups with matching metadata.
config.shared_context_metadata_behavior = :apply_to_host_groups

# The settings below are suggested to provide a good initial experience
# with RSpec, but feel free to customize to your heart's content.
=begin
# This allows you to limit a spec run to individual examples or groups
# you care about by tagging them with `:focus` metadata. When nothing
# is tagged with `:focus`, all examples get run. RSpec also provides
# aliases for `it`, `describe`, and `context` that include `:focus`
# metadata: `fit`, `fdescribe` and `fcontext`, respectively.
config.filter_run_when_matching :focus
# Allows RSpec to persist some state between runs in order to support
# the `--only-failures` and `--next-failure` CLI options. We recommend
# you configure your source control system to ignore this file.
config.example_status_persistence_file_path = "spec/examples.txt"
# Limits the available syntax to the non-monkey patched syntax that is
# recommended. For more details, see:
# - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
# - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
# - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
config.disable_monkey_patching!
# This setting enables warnings. It's recommended, but in some cases may
# be too noisy due to issues in dependencies.
config.warnings = true
# Many RSpec users commonly either run the entire suite or an individual
# file, and it's useful to allow more verbose output when running an
# individual spec file.
if config.files_to_run.one?
# Use the documentation formatter for detailed output,
# unless a formatter has already been configured
# (e.g. via a command-line flag).
config.default_formatter = "doc"
end
# Print the 10 slowest examples and example groups at the
# end of the spec run, to help surface which specs are running
# particularly slow.
config.profile_examples = 10
# Run specs in random order to surface order dependencies. If you find an
# order dependency and want to debug it, you can fix the order by providing
# the seed, which is printed after each run.
# --seed 1234
config.order = :random
# Seed global randomization in this process using the `--seed` CLI option.
# Setting this allows you to use `--seed` to deterministically reproduce
# test failures related to randomization by passing the same `--seed` value
# as the one that triggered the failure.
Kernel.srand config.seed
=end
end

0 comments on commit 360d2c8

Please sign in to comment.