nanoid_ext 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f39b37229397ed9cf1220f6843631c967b733ebc2c5112a748009a0b0cda82d
+  data.tar.gz: c808067c17a559443c1ce1c5ee82439f735791a2ade6328a8d76017bd8617449
+SHA512:
+  metadata.gz: 66be06f10922f7e1c25c6b9d590510ee23abffee8454c1578251c2c14f050cece92cea8cb8bbb17e67bbe54fd56845cf9b1c19d19bb3155e42ee05630bba873f
+  data.tar.gz: d5f19f3556ad1ca91f4b4f324fda8cb753df2ae5885f1efe80023ac45c1d4a034435e36bc06091b227cce03283f76d9540eb3c295251a72b33743a18179cfd6c

data/.github/workflows/ci.yml

@@ -0,0 +1,18 @@
+---
+name: CI
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: [2.5, 2.6, 2.7, truffleruby]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: bundle exec rake

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# rspec failure tracking
+.rspec_status
+ext/vendor/nanoid_cpp/build/

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/nanoid_cpp"]
+	path = vendor/nanoid_cpp
+	url = https://github.com/mcmikecreations/nanoid_cpp

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at i.kerseymer@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nanoid.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rake-compiler', github: 'rake-compiler/rake-compiler'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,42 @@
+GIT
+  remote: https://github.com/rake-compiler/rake-compiler.git
+  revision: bf3a3c03cbafeeb49bc006505e037151797f6f0a
+  specs:
+    rake-compiler (1.1.2)
+      rake
+
+PATH
+  remote: .
+  specs:
+    nanoid_ext (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  nanoid_ext!
+  rake (~> 12.0)
+  rake-compiler!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Ian Ker-Seymer
+
+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.

data/README.md

@@ -0,0 +1,45 @@
+# Nanoid
+
+A fast implementation of NanoID in Ruby which binds to C++ code from https://github.com/mcmikecreations/nanoid_cpp
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nanoid_ext'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install nanoid_ext
+
+## Usage
+
+```ruby
+Nanoid.generate #=> "pRfARBHnLKa4mcgQqJySL"
+Nanoid.generate(8) #=> "V5pV5ooe"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 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]/nanoid. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/nanoid/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Nanoid project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/nanoid/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,34 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rake/extensiontask'
+
+task build: :compile
+
+spec = Gem::Specification.new do |spec|
+  spec.name = 'nanoid_ext'
+  spec.version = Nanoid::VERSION
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+  spec.authors = ['Ian Ker-Seymer']
+  spec.email = ['i.kerseymer@gmail.com']
+
+  spec.summary = 'C++ extension for nanoid gem'
+  spec.description =
+    'C++ extension for nanoid gem: A tiny, secure URL-friendly unique string ID generator.'
+  spec.platform = Gem::Platform::RUBY
+
+
+  spec.extensions = ['ext/nanoid_ext/extconf.rb']
+end
+
+# add your default gem packing task
+Gem::PackageTask.new(spec) do |pkg|
+end
+
+Rake::ExtensionTask.new('ext', spec) do |ext|
+  ext.ext_dir = 'ext/nanoid_ext'
+end
+
+task default: %i[clobber compile spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'nanoid'
+
+# 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__)

data/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

data/ext/nanoid_ext/extconf.rb

@@ -0,0 +1,43 @@
+require 'mkmf'
+
+$CXXFLAGS << ' -std=c++11 -fPIC '
+
+MAKE =
+  if Gem.win_platform?
+    find_executable('make')
+  else
+    find_executable('gmake') || find_executable('make')
+  end
+
+LIBNANOID_DIR = File.join(__dir__, './../../vendor/nanoid_cpp')
+
+def sys(cmd)
+  puts " -- #{cmd}"
+  unless ret = xsystem(cmd)
+    raise "ERROR: '#{cmd}' failed"
+  end
+  ret
+end
+
+def install_deps
+  sys 'git submodule update --init --recursive'
+end
+
+def build_libnanoid
+  Dir.chdir LIBNANOID_DIR do
+    FileUtils.mkdir_p 'build'
+
+    Dir.chdir 'build' do
+      sys 'cmake -DBUILD_CLAR=OFF -DBUILD_SHARED_LIBS=OFF -DCMAKE_CXX_FLAGS=-fPIC -DCMAKE_BUILD_TYPE=RelWithDebInfo ..'
+      sys MAKE
+    end
+  end
+
+  dir_config('nanoid', "#{LIBNANOID_DIR}/inc", "#{LIBNANOID_DIR}/build")
+
+  abort 'ERROR: Failed to build libnanoid' unless have_library 'nanoid'
+end
+
+install_deps
+build_libnanoid
+create_makefile('nanoid/ext')

data/ext/nanoid_ext/nanoid_ext.cc

@@ -0,0 +1,26 @@
+#include "nanoid_ext.h"
+#include "nanoid_ext.h"
+#include "nanoid/nanoid.h"
+
+VALUE rb_mNanoid;
+
+extern "C"
+VALUE
+nanoid_generate(int argc, VALUE* argv, VALUE self)
+{
+	VALUE length = Qnil;
+	rb_scan_args(argc, argv, "01", &length);
+  int len = NIL_P(length) ? 21 : FIX2INT(length);
+
+  std::string id = nanoid::generate(len);
+
+  return rb_str_new(id.c_str(), id.size());
+}
+
+extern "C"
+void
+Init_ext(void)
+{
+  rb_mNanoid = rb_define_module("Nanoid");
+  rb_define_module_function(rb_mNanoid, "generate",  reinterpret_cast<VALUE (*)(...)>(nanoid_generate), -1);
+}

data/ext/nanoid_ext/nanoid_ext.h

@@ -0,0 +1,6 @@
+#ifndef NANOID_H
+#define NANOID_H 1
+
+#include "ruby.h"
+
+#endif /* NANOID_H */

data/lib/nanoid/version.rb

@@ -0,0 +1,3 @@
+module Nanoid
+  VERSION = '0.1.0'
+end

data/lib/nanoid.rb

@@ -0,0 +1,5 @@
+require 'nanoid/version'
+require 'nanoid/ext'
+
+module Nanoid
+end

data/nanoid.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/nanoid/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'nanoid_ext'
+  spec.version = Nanoid::VERSION
+  spec.authors = ['Ian Ker-Seymer']
+  spec.email = ['i.kerseymer@gmail.com']
+
+  spec.summary = 'C++ extension for nanoid gem'
+  spec.description =
+    'C++ extension for nanoid gem: A tiny, secure URL-friendly unique string ID generator.'
+  spec.homepage = 'https://github.com/ianks/nanoid_ext'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # 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 do |f|
+        f.match(%r{^(test|spec|features)/})
+      end
+    end
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.extensions = ['ext/nanoid_ext/extconf.rb']
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: nanoid_ext
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ian Ker-Seymer
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-16 00:00:00.000000000 Z
+dependencies: []
+description: 'C++ extension for nanoid gem: A tiny, secure URL-friendly unique string
+  ID generator.'
+email:
+- i.kerseymer@gmail.com
+executables: []
+extensions:
+- ext/nanoid_ext/extconf.rb
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".gitmodules"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/nanoid_ext/extconf.rb
+- ext/nanoid_ext/nanoid_ext.cc
+- ext/nanoid_ext/nanoid_ext.h
+- lib/nanoid.rb
+- lib/nanoid/version.rb
+- nanoid.gemspec
+homepage: https://github.com/ianks/nanoid_ext
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ianks/nanoid_ext
+  source_code_uri: https://github.com/ianks/nanoid_ext
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: C++ extension for nanoid gem
+test_files: []