unit_manager 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72a24ca7e42854fd6d1b3a7e92f8fd983bf74887b0a67b13149ba95f0213f7f5
+  data.tar.gz: 3db3386967d769987fefe8c813c6617c83724830638698722d147e79cf6e970f
+SHA512:
+  metadata.gz: f36cc4400be9659e4b1518c1343ae96eb9504deadfe3a8ea95ce95ce990b8a3be40277071a03f87691679998e968c42038199e4f5e55a529ff0e6475a41f8ca8
+  data.tar.gz: 42835c1beaf75935656414a82a2d31e18002a09e74b2007d57ff1715f3b58055b804e270a4f5ce6c654cca3dad064e49e83402b3ccd0041e327ea72ee34c4598

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in unit_manager.gemspec
+gemspec

data/README.md

@@ -0,0 +1,73 @@
+# UnitManager
+
+## 概要
+
+単位を管理する gem です。この gem を活用することで、「円」や「cm」などのモノの単位を扱いやすくします。  
+一つの yml ファイルに単位名と単位を表示する時の計算式を記述しておくことで、プログラム内で単位を呼び出す時にその計算式に従って単位名と共に値が出力されます。  
+単位や計算式を修正する場合も yml ファイルを編集するのみのため、プログラム上の修正は不要になります。
+
+## 使用方法
+
+### 1. gemfile に追記
+
+```
+gem 'unit_manager'
+```
+
+### 2. コマンドを利用して gem UnitManager をプロジェクトで利用可能にする
+
+**必ずプロジェクトディレクトリ直下で使用してください(gemfile が存在する場所)**  
+ 単位を管理する yml ファイルが作成されます。
+
+```
+unit init
+```
+
+### 3. /unit_config/unit.yml に扱う単位を記述する
+
+equation で指定した式により計算された値が単位名と共に戻り値として受け取れます。
+
+- key: 単位のキー名 `(キー名を利用してプログラムから単位にアクセスする)`
+- name: 単位名 `(プログラムから単位が呼び出された時に値と共に出力される単位名 例: 円)`
+- quation: 単位算出式 `(ここで定義された計算式を利用して値が算出されて表示される)`
+
+#### equation について
+
+- 式中の<value>と記述した部分にプログラム内で指定した値が代入されて計算されます。
+- 演算子は+, -, \*, /が使用できます。
+
+```
+# 例
+units:
+  - key: money
+    name: 円
+    equation: <value> * 1.1
+  - key: length
+    name: m
+    equation: <value>
+```
+
+### 4. gem を require する
+
+```
+require('unit_manager')
+```
+
+### 5. unit_manager をプログラム内で利用可能にする
+
+UnitManager::InitializeUnit.new を利用することで、yml ファイルに定義した単位が読み込まれます。  
+ UnitManager::InitializeUnit クラスのアクセサメソッドである units に単位情報が入っています。
+
+```
+units = UnitManager::InitializeUnit.new.units
+```
+
+### 6. 単位を取得する
+
+unit.yml に記述されているキー名が、units のキー名になっています。このキー名によって取得する単位を切り替えます。  
+ units['指定のキー名']の中に unit クラスが存在し、unit メソッドによって単位が呼び出されます。このメソッドの引数に値を渡す事によって equation で指定した計算式に従って単位も含めて値を出力します。
+
+```
+units['money'].unit(1000)
+=> 1100円
+```

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/docment/jp_readme.md

@@ -0,0 +1,73 @@
+# UnitManager
+
+## 概要
+
+単位を管理する gem です。この gem を活用することで、「円」や「cm」などのモノの単位を扱いやすくします。  
+一つの yml ファイルに単位名と単位を表示する時の計算式を記述しておくことで、プログラム内で単位を呼び出す時にその計算式に従って単位名と共に値が出力されます。  
+単位や計算式を修正する場合も yml ファイルを編集するのみのため、プログラム上の修正は不要になります。
+
+## 使用方法
+
+### 1. gemfile に追記
+
+```
+gem 'unit_manager'
+```
+
+### 2. コマンドを利用して gem UnitManager をプロジェクトで利用可能にする
+
+**必ずプロジェクトディレクトリ直下で使用してください(gemfile が存在する場所)**  
+ 単位を管理する yml ファイルが作成されます。
+
+```
+unit init
+```
+
+### 3. /unit_config/unit.yml に扱う単位を記述する
+
+equation で指定した式により計算された値が単位名と共に戻り値として受け取れます。
+
+- key: 単位のキー名 `(キー名を利用してプログラムから単位にアクセスする)`
+- name: 単位名 `(プログラムから単位が呼び出された時に値と共に出力される単位名 例: 円)`
+- quation: 単位算出式 `(ここで定義された計算式を利用して値が算出されて表示される)`
+
+#### equation について
+
+- 式中の<value>と記述した部分にプログラム内で指定した値が代入されて計算されます。
+- 演算子は+, -, \*, /が使用できます。
+
+```
+# 例
+units:
+  - key: money
+    name: 円
+    equation: <value> * 1.1
+  - key: length
+    name: m
+    equation: <value>
+```
+
+### 4. gem を require する
+
+```
+require('unit_manager')
+```
+
+### 5. unit_manager をプログラム内で利用可能にする
+
+UnitManager::InitializeUnit.new を利用することで、yml ファイルに定義した単位が読み込まれます。  
+ UnitManager::InitializeUnit クラスのアクセサメソッドである units に単位情報が入っています。
+
+```
+units = UnitManager::InitializeUnit.new.units
+```
+
+### 6. 単位を取得する
+
+unit.yml に記述されているキー名が、units のキー名になっています。このキー名によって取得する単位を切り替えます。  
+ units['指定のキー名']の中に unit クラスが存在し、unit メソッドによって単位が呼び出されます。このメソッドの引数に値を渡す事によって equation で指定した計算式に従って単位も含めて値を出力します。
+
+```
+units['money'].unit(1000)
+=> 1100円
+```

data/exe/unit.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+GEM_INSTALL_PATH = __dir__.slice!(0, __dir__.size-4)
+
+def confirmation
+  unit_config_path_file = File.open("#{GEM_INSTALL_PATH}/config/unit_config_path.txt", 'r')
+  unit_config_path = unit_config_path_file.read
+  unit_config_path_file.close
+  puts unit_config_path
+end
+
+def init
+  Dir.mkdir('unit_config') unless Dir.exist?('unit_config')
+  File.new('unit_config/unit.yml', 'w') unless File.exist?("unit_config/unit.yml")
+
+  File.open("#{GEM_INSTALL_PATH}/config/unit_config_path.txt", mode = 'w') do | f |
+    f.write("#{Dir.pwd}/unit_config/unit.yml")
+  end
+  
+  puts '=== Initialize Exit ==='
+  puts '- unit_config/unit.yml'
+end
+
+
+case ARGV[0]
+when 'init'
+  init
+when 'confirmation'
+  confirmation
+else
+  puts 'command does not exist'
+end

data/lib/unit_manager/initialize_unit.rb

@@ -0,0 +1,33 @@
+module UnitManager
+  class InitializeUnit
+    require 'yaml'
+    require_relative 'unit'
+
+    attr_reader :units
+
+    def initialize
+      units_hash = open(unit_config_path, 'r') { |f| YAML.load(f) }
+
+      units = units_hash['units'].each_with_object({}) do |unit, units|
+        split_equation = unit['equation'].split
+        raise InvalidEquation, "too long equation invalid: #{unit['equation']}" if UnitManager::Unit::MAX_EQUATION_SIZE < split_equation.size
+        raise InvalidEquation, "<value> does not exist equation invalid: #{unit['equation']}" unless split_equation.include?('<value>')
+        raise InvalidEquation, "equationv contains invalid symbol: #{unit['equation']}" if split_equation.any? {|equation_symbol| UnitManager::Unit::INVALID_EQUATION_SYMBOL.include?(equation_symbol)}
+
+        units["#{unit['key']}"] = UnitManager::Unit.new(key: unit['key'], name: unit['name'], equation: unit['equation'])
+      end
+
+      @units = units
+    end
+
+    def unit_config_path
+      gem_install_path = __dir__.slice!(0, __dir__.size-17)
+
+      unit_config_path_file = File.open("#{gem_install_path}/config/unit_config_path.txt", 'r')
+      unit_config_path = unit_config_path_file.read
+      unit_config_path_file.close
+
+      unit_config_path
+    end
+  end
+end

data/lib/unit_manager/unit.rb

@@ -0,0 +1,30 @@
+module UnitManager
+  class Unit
+    require 'active_support'
+    require_relative '../util/calculation_helper'
+    include CalculationHelper
+
+    MAX_EQUATION_SIZE = 999
+    INVALID_EQUATION_SYMBOL = ["(", ")", "!", "&", "%"]
+
+    def initialize(key:, name:, equation:)
+      @key = key
+      @name = name
+      @equation = equation
+    end
+
+    def unit(value)
+      "#{derive_value(value)}#{@name}"
+    end
+
+    private
+
+    def derive_value(value)
+      split_equation = @equation.split
+
+      split_equation.map! { |array_value| array_value == "<value>" ? value.to_s : array_value }
+
+      calculation_equation(split_equation: split_equation)
+    end
+  end
+end

data/lib/unit_manager/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module UnitManager
+  VERSION = "0.1.0"
+end

data/lib/unit_manager.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "unit_manager/version"
+require_relative "unit_manager/unit"
+require_relative "unit_manager/initialize_unit"
+
+module UnitManager
+  class Error < StandardError; end
+  class InvalidEquation < Error; end
+end

data/lib/util/calculation_helper.rb

@@ -0,0 +1,62 @@
+module CalculationHelper
+  def calculation_equation(split_equation:)
+  
+    while split_equation.index('*').present? || split_equation.index('/').present? do
+      multiplication_index = split_equation.index('*').presence || UnitManager::Unit::MAX_EQUATION_SIZE
+      division_index = split_equation.index('/').presence || UnitManager::Unit::MAX_EQUATION_SIZE
+  
+      if multiplication_index <= division_index
+        multiplication(split_equation: split_equation, index: multiplication_index)
+        next
+      end
+      
+      if division_index < multiplication_index
+        division(split_equation: split_equation, index: division_index)
+        next
+      end
+    end
+  
+    while split_equation.index('+').present? || split_equation.index('-').present? do
+      addition_index = split_equation.index('+').presence || UnitManager::Unit::MAX_EQUATION_SIZE
+      subtraction_index = split_equation.index('-').presence || UnitManager::Unit::MAX_EQUATION_SIZE
+  
+      if addition_index <= subtraction_index
+        addition(split_equation: split_equation, index: addition_index)
+        next
+      end
+      
+      if subtraction_index < addition_index
+        subtraction(split_equation: split_equation, index: subtraction_index)
+        next
+      end
+    end
+  
+    result = split_equation[0]
+  
+    result.to_f.round
+  end
+  
+  def multiplication(split_equation:, index:)
+    result = split_equation[index-1].to_f * split_equation[index+1].to_f
+    split_equation.slice!(index, 2)
+    split_equation[index-1] = result.to_s
+  end
+  
+  def division(split_equation:, index:)
+    result = split_equation[index-1].to_f / split_equation[index+1].to_f
+    split_equation.slice!(index, 2)
+    split_equation[index-1] = result.to_s
+  end
+  
+  def addition(split_equation:, index:)
+    result = split_equation[index-1].to_f + split_equation[index+1].to_f
+    split_equation.slice!(index, 2)
+    split_equation[index-1] = result.to_s
+  end
+  
+  def subtraction(split_equation:, index:)
+    result = split_equation[index-1].to_f - split_equation[index+1].to_f
+    split_equation.slice!(index, 2)
+    split_equation[index-1] = result.to_s
+  end
+end

data/sig/unit_manager.rbs

@@ -0,0 +1,4 @@
+module UnitManager
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: unit_manager
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- NaoyukiKojima
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Manage units easily.
+email:
+- programkoji213@gmail.com
+executables:
+- unit.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- config/unit_config_path.txt
+- docment/jp_readme.md
+- exe/unit.rb
+- lib/unit_manager.rb
+- lib/unit_manager/initialize_unit.rb
+- lib/unit_manager/unit.rb
+- lib/unit_manager/version.rb
+- lib/util/calculation_helper.rb
+- sig/unit_manager.rbs
+homepage: https://github.com/KojimaNaoyuki/unit_manager
+licenses: []
+metadata:
+  homepage_uri: https://github.com/KojimaNaoyuki/unit_manager
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A gem that manages units.
+test_files: []