mwc 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 925b00ab93076748302d2dad5679a40efb4f7591665573442575628968412b08
-  data.tar.gz: 262c0c7220decf69df1df2bb0caa03a27e1ad0acdfed47b9a00a41f0b9b327cd
+  metadata.gz: 690be51483f8bb3eb16c1f4a85cfa326bd2602af973c04e06423b7fa445a83db
+  data.tar.gz: a43bc9935ac9648f72748f88806926e96cc2a1465f27fc3f9274cb9a40689162
 SHA512:
-  metadata.gz: ac13dfcb13e3981b5921f2d164da25ea1b6c2ae8eb7e6e7ca4628b68374b268c916c5db0f38decaca63d864e3d335bdfa4faee01aff571c1a5e27e72bf17edac
-  data.tar.gz: 41ce0005d7968418b91462788ec2f29030d31f881ff9e8a273aa9ba8a28bfc431e4d12d8caca2d14b21fc4db80462688051504fde0a0f02f72c0f5cdabe0de89
+  metadata.gz: 22abdd8b084890f6cac3b7d73fc3e6873cb5e1a43c79aaab5294897cb143e322bb51bc91f5365f9407b748c6afa7442cb916cbdefa56a791ef2e70b5ed2d1e44
+  data.tar.gz: e485459b5a4d99302d229a07e533c0a4547866054a3a6319efc134f320d91d41e30d3852c51a916725dc9a1cfc511837fb37b6c85234d2b5096677c2e98da6ab

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mwc (0.2.0)
+    mwc (0.3.0)
       rack (~> 2.0.7)
       rake (~> 10.0)
       thor (~> 0.20.3)

data/README.md

@@ -37,34 +37,12 @@ Execute below command with your project name:
 
 This gem will create a directory `my_mrb` with anything you need to play with mruby on WebAssembly.
 
-### Configure
-
-We use the DSL to specify compile behavior, edit `.mwcrc` to change it.
-
-### Add some source code
-
-```c
-// src/main.c
-
-#include<mruby.h>
-#include<mruby/compile.h>
-#include<mruby/string.h>
-
-int main() {
-  mrb_state* mrb = mrb_open();
-  mrb_load_string(mrb, "puts 'Hello World'");
-  mrb_close(mrb);
-
-  return 0;
-}
-```
-
 ### Source code detect
 
-* `src/**/*.c` the normal c code
-* `src/js/**/*.lib.js` the JavaScript library can call it inside C
-* `src/js/**/*.pre.js` the JavaScript prepend WebAssembly JS
-* `src/js/**/*.post.js` the JavaScript append WebAssembly JS
+* `src/**/*.c` the normal C code
+* `src/js/**/*.lib.js` the JavaScript library can be called in C
+* `src/js/**/*.pre.js` the JavaScript prepend to WebAssembly JS
+* `src/js/**/*.post.js` the JavaScript append to WebAssembly JS
 
 ### Compile
 
@@ -72,12 +50,14 @@ To compile `*.c` to `.wasm` you have to execute `compile` command:
 
     $ mwc compile
 
+You can specify compile environment to change with different options:
+
+    $ mwc compile --env=dev
+
 To see more usage with `help` command:
 
     $ mwc help compile
 
-> Current only support minimal compile feature, the optimize and source map will be added soon.
-
 ### Serve compiled files
 
 The `mwc` has built-in static file server to help preview or debug:
@@ -86,10 +66,33 @@ The `mwc` has built-in static file server to help preview or debug:
 
 And then, open the `http://localhost:8080` you will see the Emscripten web shell and `Hello World` is printed.
 
-## Roadmap
+## Configure
+
+We use DSL to define the compile preferences in `.mwcrc`
+
+```ruby
+project.name = 'mruby'
+mruby.version = '2.1.3'
+
+env :dev do
+  project.source_map = true
+end
+```
+
+### Project
+
+|Name|Type|Description
+|----|-----------
+|name|string| The project name, will change the generated file name. ex. `mruby.wasm`
+|shell|string| The shell file template, if you want to use your own html template
+|source_map|boolean| Enable source map for debug
+|options|array| Extra compile options. ex. `-s ALLOW_MEMORY_GROWTH=1`
+
+### mruby
 
-* [ ] Refactor compile function
-* [ ] Environment-based compile
+|Name|Type|Description
+|----|-----------
+|version|string| The prefer mruby version
 
 ## Development
 

data/lib/mwc/command.rb

@@ -13,6 +13,8 @@ module Mwc
   class Command < Thor
     include Utils::CommandRegistry
 
+    class_option :env, desc: 'the prefer environment'
+
     desc 'version', 'show version'
     def version
       puts Mwc::VERSION

data/lib/mwc/commands/compile.rb

@@ -10,6 +10,7 @@ module Mwc
   module Commands
     # Compile mruby to wasm
     class Compile < Thor::Group
+      include Thor::Actions
       include Utils::Command
 
       name 'compile'
@@ -18,8 +19,13 @@ module Mwc
       add_option :format, default: 'html', enum: %w[html js wasm]
 
       def compile
-        Tasks.new
-        Rake::Task[parent_options['format']].invoke
+        Mwc.use(parent_options['env']) do
+          # TODO: Allow change output directory
+          empty_directory('dist')
+
+          Tasks.new
+          Rake::Task[parent_options['format']].invoke
+        end
       end
     end
   end

data/lib/mwc/commands/init.rb

@@ -17,7 +17,7 @@ module Mwc
       argument :name, type: :string, desc: 'project name'
 
       def create_project
-        empty_directory(name)
+        directory('app', name)
         self.destination_root = name
         Mwc.root = destination_root
       end
@@ -25,21 +25,13 @@ module Mwc
       # :nodoc:
       def create_mwcrc
         template('mwcrc.erb', '.mwcrc')
-      end
-
-      # :nodoc:
-      def setup_project
-        empty_directory('vendor')
-        empty_directory('dist')
-        empty_directory('src/js')
-        copy_file('config/build.rb')
-        copy_file('.gitignore')
+        Mwc.config = Pathname.new(destination_root).join('.mwcrc')
       end
 
       # :nodoc:
       def download_mruby
-        Mwc.config.reload!
         # TODO: Allow choose download mode
+        empty_directory('vendor')
         inside(mruby_directory.dirname) do
           run("curl -OL #{archive_url}")
           run("tar -zxf #{filename}")
@@ -50,8 +42,9 @@ module Mwc
 
       private
 
+      # :nodoc:
       def version
-        Mwc.config.mruby.version
+        Mwc.mruby.version
       end
 
       # :nodoc:
@@ -64,8 +57,9 @@ module Mwc
         "#{version}.tar.gz"
       end
 
+      # :nodoc:
       def mruby_directory
-        Mwc.config.mruby.path
+        Mwc.mruby.path
       end
     end
   end

data/lib/mwc/compile_options.rb

@@ -32,10 +32,9 @@ module Mwc
     # @since 0.2.0
     # @api private
     def setup_shell
-      return if Mwc.config.project.shell.nil?
+      return if Mwc.project.shell.nil?
 
-      path = Mwc.root.join(Mwc.config.project.shell)
-      @options.push "--shell-file #{path}"
+      @options.push "--shell-file #{Mwc.project.shell}"
     end
 
     # Setup source map
@@ -43,7 +42,7 @@ module Mwc
     # @since 0.2.0
     # @api private
     def setup_source_map
-      return unless Mwc.config.project.source_map
+      return unless Mwc.project.source_map
 
       @options.push '-g4 --source-map-base /'
     end
@@ -53,10 +52,10 @@ module Mwc
     # @since 0.2.0
     # @api private
     def setup_extra
-      return unless Mwc.config.project.options.any?
+      return unless Mwc.project.options.any?
 
-      Mwc.config.project.options.each do |name, value|
-        @options.push "-s #{name}=#{value}"
+      Mwc.project.options.each do |option|
+        @options.push option
       end
     end
 
@@ -88,7 +87,7 @@ module Mwc
     # @since 0.1.0
     # @api private
     def output(format)
-      @options.push "-o dist/#{Mwc.config.project.name}.#{format}"
+      @options.push "-o dist/#{Mwc.project.name}.#{format}"
     end
   end
 end

data/lib/mwc/config.rb

@@ -1,50 +1,34 @@
 # frozen_string_literal: true
 
 require 'forwardable'
-require 'singleton'
 
-require 'mwc/project'
-require 'mwc/mruby'
+require 'mwc/environment'
 require 'mwc'
 
 module Mwc
   # The compile preferences
   class Config
-    class << self
-      extend Forwardable
+    extend Forwardable
 
-      delegate %i[
-        exist?
-        mruby
-      ] => :instance
-    end
+    # @since 0.3.0
+    # @api private
+    delegate %i[environments] => :@default
 
-    include Singleton
+    # @since 0.3.0
+    # @api private
+    LOCK = Mutex.new
 
-    attr_reader :project, :mruby
+    # @since 0.3.0
+    # @api private
+    attr_reader :default
 
     # :nodoc:
-    def initialize
-      @path = Mwc.root.join('.mwcrc')
-      @project = Project.new
-      @mruby = MRuby.new
-
+    def initialize(path = Mwc.root.join('.mwcrc'))
+      @path = Pathname.new(path)
+      @default = Environment.new
       load_config if exist?
     end
 
-    # TODO: Move to DSL module
-    # Set name
-    #
-    # @param name [String|NilClass] the name
-    #
-    # @since 0.1.0
-    # @api private
-    def name(name = nil)
-      return @name if name.nil?
-
-      @name = name.to_s
-    end
-
     # Check config file exists
     #
     # @return [TrueClass,FalseClass] exist or not
@@ -59,12 +43,8 @@ module Mwc
     #
     # @since 0.1.0
     # @api private
-    def reload!
-      # TODO: Update path when root changed
-      @path = Mwc.root.join('.mwcrc')
-      return unless exist?
-
-      load_config
+    def reload
+      Mwc.config = Mwc.root.join('.mwcrc')
     end
 
     private
@@ -74,8 +54,7 @@ module Mwc
     # @since 0.1.0
     # @api private
     def load_config
-      # TODO: Improve config DSL
-      instance_eval(@path.read)
+      LOCK.synchronize { @default.instance_eval(@path.read) }
     end
   end
 end

data/lib/mwc/environment.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'mwc/options/project'
+require 'mwc/options/mruby'
+
+module Mwc
+  # The compile environment manager
+  #
+  # @since 0.3.0
+  # @api private
+  class Environment
+    # @since 0.3.0
+    # @api private
+    attr_reader :environments, :project, :mruby
+
+    # @since 0.3.0
+    # @api private
+    def initialize(parent = nil, &block)
+      @parent = parent
+      @environments = {}
+      @project = Options::Project.new(parent&.project)
+      @mruby = Options::MRuby.new(parent&.mruby)
+      instance_exec(self, &block) if block_given?
+    end
+
+    # Define new environment
+    #
+    # @param name [Symbol] the environment name
+    # @param block [Proc] the environment config block
+    #
+    # @since 0.3.0
+    # @api private
+    def env(name, &block)
+      return if @parent
+
+      @environments[name.to_sym] = Environment.new(self, &block)
+    end
+  end
+end

data/lib/mwc/options/mruby.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'mwc/utils/option'
+
+module Mwc
+  module Options
+    # The mruby preference
+    class MRuby
+      include Utils::Option
+
+      option :version
+      option :path, type: :path, default: 'vendor/mruby'
+    end
+  end
+end

data/lib/mwc/options/project.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'mwc/utils/option'
+
+module Mwc
+  module Options
+    # The project related options
+    class Project
+      include Utils::Option
+
+      option :name
+      option :source_map, type: :bool
+      option :shell, type: :path
+      option :options, array: true
+    end
+  end
+end

data/lib/mwc/server.rb

@@ -17,7 +17,7 @@ module Mwc
         Rack::Static.new(
           ->(_) { [404, {}, []] },
           root: 'dist', # TODO: Set by config
-          index: "#{Mwc.config.project.name}.html",
+          index: "#{Mwc.project.name}.html",
           urls: [''],
           header_rules: [
             [WASM_RULE, WASM_HEADER]

data/lib/mwc/tasks.rb

@@ -77,7 +77,7 @@ module Mwc
 
     # :nodoc:
     def mruby_directory
-      Mwc.config.mruby.path
+      Mwc.mruby.path
     end
   end
 end

data/lib/mwc/templates/app/src/main.c

@@ -0,0 +1,11 @@
+#include<mruby.h>
+#include<mruby/compile.h>
+#include<mruby/string.h>
+
+int main() {
+  mrb_state* mrb = mrb_open();
+  mrb_load_string(mrb, "puts 'Hello, mruby on WebAssembly'");
+  mrb_close(mrb);
+
+  return 0;
+}

data/lib/mwc/templates/mwcrc.erb

@@ -1,12 +1,15 @@
-# vim: set filetype=ruby
+# vi: set ft=ruby :
+
+# frozen_string_literal: true
 
 # Project settings
 project.name = '<%= name %>'
 # project.shell = 'src/shell.html'
-# project.source_map = true
-
-# -s ALLOW_MEMORY_GROWTH=1
-# project.option 'ALLOW_MEMORY_GROWTH', '1'
+# project.options '-s ALLOW_MEMORY_GROWTH=1'
 
 # mruby settings
 mruby.version = '2.1.0'
+
+env :dev do
+  project.source_map = true
+end

data/lib/mwc/utils/hash_accessor.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Mwc
+  module Utils
+    # Provide Hash-like accessor
+    module HashAccessor
+      # Hash-like getter
+      #
+      # @param name [String|Symbol] the option name
+      #
+      # @since 0.3.0
+      # @api private
+      def [](name)
+        return unless respond_to?(name)
+
+        send(name)
+      end
+
+      # Hash-like setter
+      #
+      # @param name [String|Symbol] the option name
+      # @param value [Object] the option value
+      #
+      # @since 0.3.0
+      # @api private
+      def []=(name, value)
+        return unless respond_to?("#{name}=")
+
+        send("#{name}=", value)
+      end
+    end
+  end
+end

data/lib/mwc/utils/option.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'mwc/utils/hash_accessor'
+
+module Mwc
+  module Utils
+    # Extend option class
+    module Option
+      # :nodoc:
+      def self.included(base)
+        base.class_eval do
+          extend ClassMethods
+          include HashAccessor
+
+          def initialize(parent)
+            @parent = parent
+          end
+        end
+      end
+
+      # :nodoc:
+      module ClassMethods
+        # Define new options
+        #
+        # @param name [String] the option name
+        #
+        # @since 0.3.0
+        # @api private
+        def option(name, options = {})
+          return create_array_option(name, options) if options[:array] == true
+
+          option_reader(name, options)
+          option_writer(name, options)
+        end
+
+        # Cast value to specify type
+        #
+        # @param value [Object] the origin value
+        # @param type [Symbol] the destination type
+        #
+        # @since 0.3.0
+        # @api private
+        def cast(value, type)
+          return if value.nil?
+
+          case type
+          when :path then Mwc.root.join(value)
+          when :bool then value == true
+          else value
+          end
+        end
+
+        private
+
+        def option_reader(name, options = {})
+          define_method name do
+            instance_variable_get("@#{name}") ||
+              @parent&.send(name) ||
+              self.class.cast(options[:default], options[:type])
+          end
+        end
+
+        def option_writer(name, options = {})
+          define_method "#{name}=" do |value|
+            instance_variable_set(
+              "@#{name}",
+              self.class.cast(value, options[:type])
+            )
+          end
+        end
+
+        def create_array_option(name, options = {})
+          define_method name do |value = nil|
+            current = instance_variable_get("@#{name}")&.dup || []
+            return current.concat(@parent&.send(name) || []).uniq if value.nil?
+
+            current.push self.class.cast(value, options[:type])
+            instance_variable_set("@#{name}", current)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mwc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mwc
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/mwc.rb

@@ -7,6 +7,10 @@ require 'mwc/config'
 
 # WebAssembly compile tool for mruby
 module Mwc
+  # @since 0.3.0
+  # @api private
+  LOCK = Mutex.new
+
   # The project root
   #
   # @return [Pathname] the root
@@ -38,7 +42,17 @@ module Mwc
   # @since 0.1.0
   # @api private
   def self.config
-    Mwc::Config.instance
+    @config ||= Config.new
+  end
+
+  # Set config
+  #
+  # @param path [Pathname] the config path
+  #
+  # @since 0.3.0
+  # @api private
+  def self.config=(path)
+    @config = Config.new(path)
   end
 
   # The thor template source root
@@ -53,4 +67,53 @@ module Mwc
       .join('mwc', 'templates')
       .to_s
   end
+
+  # Use prefer environment
+  #
+  # @param name [String] prefer environment
+  # @param block [Proc] the block execute under this environment
+  #
+  # @since 0.3.0
+  # @api private
+  def self.use(env, &_block)
+    LOCK.synchronize do
+      @env = env&.to_sym
+      yield
+      @env = nil
+    end
+  end
+
+  # Current environment
+  #
+  # @see Mwc::Environment
+  #
+  # @return [Mwc::Environment] the environment
+  #
+  # @since 0.3.0
+  # @api private
+  def self.environment
+    return config.default if @env.nil?
+
+    config.environments[@env] || config.default
+  end
+
+  # Current mruby preferences
+  #
+  # @return [Mwc::Options::MRuby] the mruby options
+  #
+  # @since 0.3.0
+  # @api private
+  def self.mruby
+    environment.mruby
+  end
+
+  # Current project preferences
+  #
+  # @return [Mwc::Options::Project] the project options
+  #
+  # @since 0.3.0
+  # @api private
+  def self.project
+    environment.project
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mwc
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - 蒼時弦也
@@ -150,15 +150,19 @@ files:
 - lib/mwc/commands/server.rb
 - lib/mwc/compile_options.rb
 - lib/mwc/config.rb
-- lib/mwc/mruby.rb
-- lib/mwc/project.rb
+- lib/mwc/environment.rb
+- lib/mwc/options/mruby.rb
+- lib/mwc/options/project.rb
 - lib/mwc/server.rb
 - lib/mwc/tasks.rb
-- lib/mwc/templates/.gitignore
-- lib/mwc/templates/config/build.rb
+- lib/mwc/templates/app/.gitignore
+- lib/mwc/templates/app/config/build.rb
+- lib/mwc/templates/app/src/main.c
 - lib/mwc/templates/mwcrc.erb
 - lib/mwc/utils/command.rb
 - lib/mwc/utils/command_registry.rb
+- lib/mwc/utils/hash_accessor.rb
+- lib/mwc/utils/option.rb
 - lib/mwc/version.rb
 - mwasm.gemspec
 homepage: https://github.com/elct9620/mwc

data/lib/mwc/mruby.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require 'mwc'
-
-module Mwc
-  # MRuby config
-  class MRuby
-    attr_accessor :version
-
-    def path
-      Mwc.root.join('vendor/mruby')
-    end
-  end
-end

data/lib/mwc/project.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Mwc
-  # The project settings
-  class Project
-    attr_accessor :name, :shell, :source_map
-    attr_reader :options
-
-    # :nodoc:
-    def initialize
-      @options = {}
-    end
-
-    # Add customize options
-    #
-    # @param name [String] the option name
-    # @param value [String] the option value
-    #
-    # @since 0.2.0
-    # @api private
-    def option(name, value)
-      @options[name] = value
-    end
-  end
-end