scad-btw 0.1.0.pre1

data/lib/extensions/kernel.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'extensions/jenncad'
+
+module Extensions
+  module Kernel
+    def require(path)
+      ret = super
+
+      if path == 'jenncad/profile_loader'
+        ::JennCad::ProfileLoader.prepend Extensions::JennCad::ProfileLoader
+      end
+
+      ret
+    end
+  end
+end

data/lib/extensions/thor.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Extensions
+  module Thor
+    module Option
+      def show_default?
+        super || [TrueClass, FalseClass].any? { |c| default.is_a?(c) }
+      end
+    end
+  end
+end

data/lib/scad/btw/base.rb

@@ -0,0 +1,224 @@
+# frozen_string_literal: true
+
+require 'scad/btw/concerns/component_args'
+require 'scad/btw/concerns/part_commons'
+
+require 'scad/btw/component/axle_hole'
+require 'scad/btw/component/center'
+require 'scad/btw/component/counterweight'
+require 'scad/btw/component/flange'
+require 'scad/btw/component/joint_base'
+require 'scad/btw/component/joint'
+require 'scad/btw/component/o_ring_groove'
+require 'scad/btw/component/solid'
+require 'scad/btw/component/spokes'
+require 'scad/btw/component/tread'
+
+module Scad
+  module Btw
+    class Base < JennCad::Part
+      include Scad::Btw::Concerns::PartCommons
+
+      # Wheel size mapping
+      # See eurobricks.com forum post https://bit.ly/3ZARZUZ for details
+      OLD_2_NEW_SIZE_MAP = {
+        'XXL' => 13,
+        'XLL' => 12,
+        'XL' => 11,
+        'LL' => 10,
+        'L' => 9,
+        'ML' => 8,
+        'M' => 7,
+        'MS' => 6,
+        'S' => 5
+      }.freeze
+
+      DEFAULTS = {
+        COLOR: :gray,
+        HEIGHT: 8,
+        INNER_HEIGHT_DIFF: -0.5,
+        IS_BLIND: false,
+        IS_THIN: true,
+        THIN_HEIGHT: 5,
+        WITH_COUNTERWEIGHT: false,
+        WITH_JOINT: false,
+        WITH_O_RING_GROOVE: false
+      }.freeze
+
+      COMPONENT_ARGS_MAPPING = {
+        axle: { height: :height },
+        center: { height: :height },
+        counterweight: { height: :inner_height, diameter: :size_2_diameter },
+        flange: { diameter: :size_2_diameter },
+        joint: { height: :height },
+        o_ring_groove: { diameter: :size_2_diameter, thin: :thin? },
+        solid: { height: :inner_height, diameter: :size_2_diameter },
+        spokes: { height: :inner_height, diameter: :size_2_diameter },
+        tread: { diameter: :size_2_diameter, height: :height }
+      }.freeze
+
+      ARGS = {
+        prefix: :wheel,
+        args: {
+          size: {
+            description: 'Wheel size.', required: true, type: :string,
+            enum: OLD_2_NEW_SIZE_MAP.keys + OLD_2_NEW_SIZE_MAP.values.map(&:to_s)
+          },
+          is_thin: {
+            description: 'Whether wheel is thin (5 mm) or not (8 mm).', default: DEFAULTS[:IS_THIN], type: :boolean
+          },
+          inner_height: {
+            description: "Height of spokes or web. Defaults to: Wheel thickness #{DEFAULTS[:INNER_HEIGHT_DIFF]}",
+            type: :numeric
+          },
+          with_o_ring_groove: {
+            description: 'Whether wheel has o-ring groove.', default: DEFAULTS[:WITH_O_RING_GROOVE], type: :boolean
+          },
+          with_joint: {
+            description: 'Whether wheel has joint.', default: DEFAULTS[:WITH_JOINT], type: :boolean
+          },
+          with_counterweight: {
+            description: 'Whether wheel has counterweight.', default: DEFAULTS[:WITH_COUNTERWEIGHT], type: :boolean
+          }
+        }
+      }.freeze
+
+      def initialize(args = {})
+        args = {}.merge(args.transform_keys(&:to_sym))
+
+        super(args)
+
+        @args = args
+      end
+
+      def part
+        (parts_additions - parts_substractions).color(color)
+      end
+
+      def self.component_classes
+        Scad::Btw::Component.constants.map(&Scad::Btw::Component.method(:const_get)).select { |c| c.is_a? Class }
+      end
+
+      def self.skip_components
+        []
+      end
+
+      private
+
+      attr_reader :args
+
+      def skip_components
+        self.class.skip_components
+      end
+
+      def parts_additions
+        res = nil
+
+        component_classes.each do |c|
+          next if skip_component?(c, :addition)
+
+          res ? res += component_part(c) : res = component_part(c)
+        end
+
+        res
+      end
+
+      def parts_substractions
+        res = nil
+
+        component_classes.each do |c|
+          next if skip_component?(c, :substraction)
+
+          res ? res += component_part(c) : res = component_part(c)
+        end
+
+        res
+      end
+
+      # components
+
+      def component_part(component_class)
+        component_class.new(component_args(component_class)).part
+      end
+
+      def component_args(component_class)
+        component_global_args(component_class).merge(component_class.component_args(args)).merge(misc_args)
+      end
+
+      def component_global_args(component_class)
+        prefix = component_class::ARGS[:prefix]
+
+        COMPONENT_ARGS_MAPPING[prefix].transform_values { |v| send(v) }
+      end
+
+      def skip_component?(component_class, type)
+        return true unless type == component_class::TYPE
+        return true if skip_components.include?(component_class::ARGS[:prefix])
+        return true if not_with?(component_class::ARGS[:prefix])
+
+        false
+      end
+
+      def not_with?(component)
+        return false unless %i[counterweight joint o_ring_groove].include?(component)
+
+        !send("with_#{component}?".to_sym)
+      end
+
+      def component_classes
+        self.class.component_classes
+      end
+
+      # functions
+
+      def misc_args
+        args.except do |key, _|
+          component_classes.join(self.class).map { |c| c.component_args_key_map.values }.flatten.include?(key)
+        end
+      end
+
+      def height
+        thin? ? DEFAULTS[:THIN_HEIGHT] : DEFAULTS[:HEIGHT]
+      end
+
+      def thin?
+        args.fetch(:wheel_is_thin, DEFAULTS[:IS_THIN])
+      end
+
+      def inner_height
+        args[:wheel_inner_height] || (height + DEFAULTS[:INNER_HEIGHT_DIFF])
+      end
+
+      # See eurobricks.com forum post https://bit.ly/3ZARZUZ for details
+      def size_2_diameter
+        (size + 0.5) * 3.2
+      end
+
+      def size
+        provided_size = args.fetch(:wheel_size)
+
+        mapped_size = OLD_2_NEW_SIZE_MAP[provided_size] || provided_size
+
+        raise "Size #{provided_size} not supportet!" unless OLD_2_NEW_SIZE_MAP.values.include?(mapped_size.to_i)
+
+        mapped_size.to_f
+      end
+
+      def color
+        args[:wheel_color] || DEFAULTS[:COLOR]
+      end
+
+      def with_counterweight?
+        args[:wheel_with_counterweight] || with_joint? || DEFAULTS[:WITH_COUNTERWEIGHT]
+      end
+
+      def with_o_ring_groove?
+        args[:wheel_with_o_ring_groove] || DEFAULTS[:WITH_O_RING_GROOVE]
+      end
+
+      def with_joint?
+        args[:wheel_with_joint] || DEFAULTS[:WITH_JOINT]
+      end
+    end
+  end
+end

data/lib/scad/btw/cli/base.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'extensions/thor'
+Thor::Option.prepend Extensions::Thor::Option
+
+require 'scad/btw'
+require_relative 'presets'
+require_relative 'solid'
+require_relative 'spoked'
+
+module Scad
+  module Btw
+    module Cli
+      class Base < Thor
+        desc 'preset SUBCOMMAND ...ARGS', 'Generate from presets'
+        subcommand 'preset', Scad::Btw::Cli::Presets
+
+        desc 'solid SUBCOMMAND ...ARGS', 'Generate solid wheel'
+        subcommand 'solid', Scad::Btw::Cli::Solid
+
+        desc 'spoked SUBCOMMAND ...ARGS', 'Generate spoked wheel'
+        subcommand 'spoked', Scad::Btw::Cli::Spoked
+
+        def self.exit_on_failure?
+          true
+        end
+      end
+    end
+  end
+end

data/lib/scad/btw/cli/concerns/export_formats.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+
+module Scad
+  module Btw
+    module Cli
+      module Concerns
+        module ExportFormats
+          extend ActiveSupport::Concern
+
+          private
+
+          def export_part(part, file, format = 'scad')
+            case format
+            when 'scad'
+              export_part_to_scad(part, file)
+            when 'stl'
+              export_stl(part, file)
+            else
+              puts "Unknown export format `#{format}`. Choose one of `scad` and `stl`."
+            end
+          end
+
+          def export_part_to_scad(part, file)
+            JennCad::Exporters::OpenScad.new(part).save(file)
+          end
+
+          def export_stl(part, file)
+            tempfile = Tempfile.new('scad')
+
+            export_part_to_scad(part, tempfile.path)
+
+            Scad::Btw::Converters::Openscad2AsciiStl.convert(in_path: tempfile.path, out_path: file)
+          ensure
+            tempfile.close
+            tempfile.unlink
+          end
+        end
+      end
+    end
+  end
+end

data/lib/scad/btw/cli/concerns/export_options.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Scad
+  module Btw
+    module Cli
+      module Concerns
+        module ExportOptions
+          extend ActiveSupport::Concern
+
+          class_methods do
+            def _gen_options
+              _wheel_options + _component_options
+            end
+
+            def _wheel_options
+              _part_options(klass: Object.const_get(self::WHEEL_CLASS_NAME))
+            end
+
+            def _part_options(klass:)
+              klass::ARGS[:args].keys.map do |key|
+                _option_args(
+                  prefix: klass::ARGS[:prefix],
+                  name: key,
+                  arg: klass::ARGS[:args][key]
+                )
+              end
+            end
+
+            def _component_options
+              Object.const_get(self::WHEEL_CLASS_NAME).component_classes
+                    .map do |cc|
+                _component_option(klass: cc)
+              end.flatten
+            end
+
+            def _component_option(klass:)
+              if Object.const_get(self::WHEEL_CLASS_NAME).skip_components
+                       .include?(klass::ARGS[:prefix])
+                []
+              else
+                _part_options(klass: klass)
+              end
+            end
+
+            def _option_args(prefix:, name:, arg:)
+              args = {
+                name: "#{prefix}_#{name}".to_sym,
+                kwargs: { desc: arg[:description] }
+              }
+
+              %i[type default required enum hide].each do |option|
+                args[:kwargs][option] = arg[option] if arg.key?(option)
+              end
+
+              args
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/scad/btw/cli/presets.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'scad/btw/cli/concerns/export_formats'
+
+module Scad
+  module Btw
+    module Cli
+      class Presets < Thor
+        include ActiveSupport::Inflector
+        include Scad::Btw::Cli::Concerns::ExportFormats
+
+        PRESETS_NAMESPACE = 'Scad::Btw::Presets'
+
+        desc 'list', 'List available presets'
+        def list
+          print list_output
+        end
+
+        option :preset, required: true, type: :string
+        desc 'export FILE [FORMAT]', 'Export preset to file in either `scad` (default) or `stl` format'
+        def export(file, format = 'scad')
+          export_part(part, file, format)
+        end
+
+        private
+
+        def part
+          preset_class_name = "#{PRESETS_NAMESPACE}::#{camelize(underscore(options[:preset]))}"
+
+          constantize(preset_class_name).to_openscad
+        end
+
+        def list_output
+          <<~LIST_OUTPUT
+            Available presets:
+
+            #{presets.map { |p| "  - #{p}" }.join("\n")}
+
+            Use `scad-btw preset export --preset <preset> <file>` to export a
+            preset to openscad.
+          LIST_OUTPUT
+        end
+
+        def presets
+          get_classes(constantize(PRESETS_NAMESPACE)).map do |c|
+            dasherize(underscore(c.name.delete_prefix("#{PRESETS_NAMESPACE}::")))
+          end
+        end
+
+        def get_classes(mod)
+          mod.constants.map do |c|
+            const = mod.const_get(c)
+            if const.is_a? Class
+              const
+            elsif const.is_a? Module
+              get_classes(const)
+            else
+              next
+            end
+          end.flatten
+        end
+      end
+    end
+  end
+end

data/lib/scad/btw/cli/solid.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'scad/btw/cli/concerns/export_options'
+require 'scad/btw/cli/concerns/export_formats'
+
+module Scad
+  module Btw
+    module Cli
+      class Solid < Thor
+        include Scad::Btw::Cli::Concerns::ExportOptions
+        include Scad::Btw::Cli::Concerns::ExportFormats
+        include ActiveSupport::Inflector
+
+        WHEEL_CLASS_NAME = 'Scad::Btw::Solid'
+
+        _gen_options.each do |conf|
+          option(conf[:name], conf[:kwargs])
+        end
+        desc 'export FILE [FORMAT]', 'Export solid wheel to file in either `scad` (default) or `stl` format'
+        def export(file, format = 'scad')
+          export_part(part, file, format)
+        end
+
+        private
+
+        def part
+          constantize(WHEEL_CLASS_NAME).to_openscad(options)
+        end
+      end
+    end
+  end
+end

data/lib/scad/btw/cli/spoked.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'scad/btw/cli/concerns/export_options'
+require 'scad/btw/cli/concerns/export_formats'
+
+module Scad
+  module Btw
+    module Cli
+      class Spoked < Thor
+        include Scad::Btw::Cli::Concerns::ExportOptions
+        include Scad::Btw::Cli::Concerns::ExportFormats
+        include ActiveSupport::Inflector
+
+        WHEEL_CLASS_NAME = 'Scad::Btw::Spoked'
+
+        _gen_options.each do |conf|
+          option(conf[:name], conf[:kwargs])
+        end
+        desc 'export FILE [FORMAT]', 'Export solid wheel to file in either `scad` (default) or `stl` format'
+        def export(file, format = 'scad')
+          export_part(part, file, format)
+        end
+
+        private
+
+        def part
+          constantize(WHEEL_CLASS_NAME).to_openscad(options)
+        end
+      end
+    end
+  end
+end

data/lib/scad/btw/component/axle_hole.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'scad/btw/concerns/component_args'
+require 'scad/btw/concerns/part_commons'
+
+module Scad
+  module Btw
+    module Component
+      class AxleHole < JennCad::Part
+        include Scad::Btw::Concerns::PartCommons
+        include Scad::Btw::Concerns::ComponentArgs
+
+        TYPE = :substraction
+        SPLINE_WIDTH = 2
+        DIAMETER = 5
+
+        ARGS = {
+          prefix: :axle,
+          args: {
+            height: {
+              description: 'Wheel height. Defaults to: Wheel height defined ' \
+                           'by wheel thickness (`wheel_is_thin` flag).',
+              type: :numeric,
+              hide: true
+            }
+          }
+        }.freeze
+
+        def initialize(args = {})
+          super
+
+          @height = args.fetch(:height)
+        end
+
+        def part
+          res = spline
+
+          res + spline.rz(90)
+        end
+
+        private
+
+        attr_reader :height
+
+        # components
+
+        def spline
+          cube(x: DIAMETER, y: SPLINE_WIDTH, z: height + 1).mz(-0.5)
+        end
+      end
+    end
+  end
+end

data/lib/scad/btw/component/center.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'scad/btw/concerns/component_args'
+require 'scad/btw/concerns/part_commons'
+
+module Scad
+  module Btw
+    module Component
+      class Center < JennCad::Part
+        include Scad::Btw::Concerns::PartCommons
+        include Scad::Btw::Concerns::ComponentArgs
+
+        TYPE = :addition
+        MIN_DIAMETER = 7.4
+
+        ARGS = {
+          prefix: :center,
+          args: {
+            height: {
+              description: 'Center height. Defaults to: Wheel height defined ' \
+                           'by wheel thickness (`wheel_is_thin` flag).',
+              type: :numeric,
+              hide: true
+            },
+            diameter: {
+              description: 'Center diameter. Minimum diameter of ' \
+                           "#{MIN_DIAMETER} will be used if provided value " \
+                           'is smaller.',
+              default: MIN_DIAMETER,
+              type: :numeric
+            }
+          }
+        }.freeze
+
+        def initialize(args = {})
+          super
+
+          @diameter = args[:diameter] || 0
+          @height = args.fetch(:height)
+        end
+
+        def part
+          cylinder(d: calculated_diameter, h: height)
+        end
+
+        private
+
+        attr_reader :diameter, :height
+
+        # functions
+
+        def calculated_diameter
+          [diameter, MIN_DIAMETER].max
+        end
+      end
+    end
+  end
+end