mruby_gem_scaffolding 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 783eb964ba50e66fb179d27ed507d4c70ef6247a34af6cdaf6c7119e50721946
+  data.tar.gz: 466bddf489420f787e08185cde1298ffd780b8494644558be6063a1bc6736d7c
+SHA512:
+  metadata.gz: 4e0952293610de3d05b4614f7baab9a987fcd403d444d158d208abab889a156c08b81a27689b5cc4c66f011328d10685f97c9b084bca885c6c822642145a954e
+  data.tar.gz: 30b44945f4c728ce689a057ca7073d992681d0fef2e831ed1b77631b116db1db7a55dd9faa81b29b098f61ed3e7d6dda0bc5e69f45b21d12897e4febffc9b995

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mruby_gem_scaffolding.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    mruby_gem_scaffolding (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mruby_gem_scaffolding!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 _Tradam
+
+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,8 @@
+# mruby Gem Scaffolding
+
+This gem allows you to easily create a basic working scaffold of an mruby gem.
+
+Install the gem by `gem install mruby_gem_scaffolding` and then run with `mruby_gem_scaffolding`
+
+https://rubygems.org/gems/mruby_gem_scaffolding
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mruby_gem_scaffolding"
+
+# 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/exe/mruby_gem_scaffolding

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require "mruby_gem_scaffolding"
+
+print "Enter your project name: "
+project_name = gets.chomp
+
+Dir.mkdir project_name unless File.exists? project_name
+if !Dir.empty? project_name
+  puts "#{project_name} directory is not empty. Quitting..."
+  return
+end
+
+print "Enter your author name: "
+user_name = gets.chomp
+
+MrubyGemScaffolding.write(
+  "./#{project_name}",
+  MrubyGemScaffolding.generate(user_name: user_name, project_name: project_name)
+)
+
+puts "Done!"

data/lib/mruby_gem_scaffolding/version.rb

@@ -0,0 +1,3 @@
+module MrubyGemScaffolding
+  VERSION = "1.0.0"
+end

data/lib/mruby_gem_scaffolding.rb

@@ -0,0 +1,127 @@
+require "mruby_gem_scaffolding/version"
+
+module MrubyGemScaffolding
+  module Utility
+    class << self
+      # from thor gem
+      def snake_case(str)
+        return str.downcase if str =~ /^[A-Z_]+$/
+        str.gsub(/\B[A-Z]/, '_\&').squeeze("_") =~ /_*(.*)/
+        Regexp.last_match(-1).downcase
+      end
+
+      # from thor gem
+      def camel_case(str)
+        return str if str !~ /_/ && str =~ /[A-Z]+.*/
+        str.split("_").map(&:capitalize).join
+      end
+    end
+  end
+
+  class << self
+    def empty_project
+      {
+        "README.md" => '',
+        "mrbgem.rake" => '',
+        "include" => {},
+        "mrblib" => {},
+        "src" => {},
+        "tools" => {},
+        "test" => {},
+        "LICENSE" => '',
+      }
+    end
+
+    def generate(user_name:, project_name:)
+      result = empty_project
+
+      result["README.md"] =
+        <<MULTILINE
+# #{Utility.camel_case(project_name)}
+An mruby gem created by #{user_name} using mruby_gem_scaffolding.
+MULTILINE
+
+      result["mrbgem.rake"] =
+        <<MULTILINE
+MRuby::Gem::Specification.new('#{Utility.snake_case(project_name)}') do |spec|
+  spec.license = 'MIT'
+  spec.author  = '#{user_name}'
+end
+MULTILINE
+
+      result["src"]["main.c"] =
+        <<MULTILINE
+#include <mruby.h>
+#include <stdio.h>
+
+// defining the function to be later bound to a ruby method
+static mrb_value
+hello_world(mrb_state *mrb, mrb_value self)
+{
+    printf("Hello World");
+
+    return mrb_nil_value(); // return null
+}
+
+// gem initializer
+void
+mrb_#{Utility.snake_case(project_name)}_gem_init(mrb_state* mrb) {
+    struct RClass *#{Utility.snake_case(project_name)}_class = mrb_define_module(mrb, "#{Utility.camel_case(project_name)}");
+    mrb_define_class_method(
+      mrb,                    // Mruby VM state
+      #{Utility.snake_case(project_name)}_class,  // Class we bind method to
+      "say_hello",            // Name of method
+      hello_world,        // Function we are binding as a method
+      MRB_ARGS_NONE()         // How many arguments are optional/required
+    );
+}
+
+// gem finalizer
+void
+mrb_#{Utility.snake_case(project_name)}_gem_final(mrb_state* mrb) {
+
+}
+MULTILINE
+
+      result["LICENSE"] =
+        <<MULTILINE
+The MIT License (MIT)
+
+Copyright (c) #{Time.now.year} #{user_name}
+
+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.
+
+MULTILINE
+
+      return result
+    end
+
+    def write(dir, hash_data)
+      Dir.mkdir dir unless File.exists? dir
+      hash_data.each do |key, value|
+        if value.is_a? Hash
+          write("#{dir}/#{key}", value)
+        else
+          File.open("#{dir}/#{key}", 'w') { |file| file.write(value) }
+        end
+      end
+    end
+  end
+
+end

data/mruby_gem_scaffolding.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/mruby_gem_scaffolding/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mruby_gem_scaffolding"
+  spec.version       = MrubyGemScaffolding::VERSION
+  spec.authors       = ["Tradam"]
+  spec.email         = ["github@tradam.dev"]
+
+  spec.summary       = %q{Creates a blank mruby gem for you with all the required files generated automatically.}
+  #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"
+  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/mruby_gem_scaffolding"
+  #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.executables = "mruby_gem_scaffolding"
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: mruby_gem_scaffolding
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tradam
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-07 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- github@tradam.dev
+executables:
+- mruby_gem_scaffolding
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/mruby_gem_scaffolding
+- lib/mruby_gem_scaffolding.rb
+- lib/mruby_gem_scaffolding/version.rb
+- mruby_gem_scaffolding.gemspec
+homepage:
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/realtradam/mruby_gem_scaffolding
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Creates a blank mruby gem for you with all the required files generated automatically.
+test_files: []