flutter_version_tool 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbad9eef2f7d73d4b77b3e7fa7ae33285be8b677c9e81dde913fe69eceaf041a
-  data.tar.gz: 64df2ffc684d9115e6672181d2d18fd4b0ce2ccf3790593782b7b5fb8c6cacde
+  metadata.gz: 30fc4b7e6fbcc9b8a500e93142f9146171b8dc1281db7ad28cdadb93a6348027
+  data.tar.gz: d11c1654e3a8cc86f07c33e7ab19c7df00f988d285466f0b383dbb995705c9d9
 SHA512:
-  metadata.gz: c94f632a80b9787e6cc4596961c68ba48d906a9493f9ae41d59e629a26af2f9febf8490d633bc98e2a6e47acff7d32e43c114145f84ecc889a82e7b08a96cd28
-  data.tar.gz: dfdb53d32f0c66ac0da153c02379149d5fdad6cf606e3063ac79696bc282a774bbd1181ab44ecaef7556c33e7cd49b12a52e4c3400a0a3368802e797cd5ba013
+  metadata.gz: 4e9201c10144571a5a59b74b83c2ec203a0a19f018a763cbfe78da1f270872ee3375623b06f4b8ddfd5ad52c85474d0ccffc72c7195b51a8fe23c1824cf9936b
+  data.tar.gz: bc11db9bc1f6a7f988cb0cdee1378f7621f41c7881a7cf22944d3e8a0f5b9a6d46632558bb04c552689c350c99cde098c60a5427f7130ab6fbb0d9d943fdc5a4

data/lib/flutter_version_tool.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+
 class FlutterVersionTool
     attr_reader :pubspecPath, :vName, :vCode, :vMajor, :vMinor, :vPatch
   
@@ -5,11 +7,19 @@ class FlutterVersionTool
       return "#{@vMajor.to_s}.#{@vMinor.to_s}.#{@vPatch.to_s}+#{@vCode.to_s}"
     end
   
-    def initialize(path)
+    def initialize(path = "pubspec.yaml")
+    # Load version from pubspec file
+    #
+    # Example:
+    #   >> fvt = FlutterVersionTool.new("some_project/path/pubspec.yaml")
+    #
+    # Arguments:
+    #   pubspecPath: (String)
+
       @pubspecPath = path
       
       begin
-        pubspec = YAML.load_file(@pubspecPath)
+        pubspec = YAML::load_file(@pubspecPath)
       rescue
         raise 'Read pubspec.yaml failed'
       end
@@ -56,16 +66,38 @@ class FlutterVersionTool
     end
   
     def changeVersionCode(p_code)
+      # Change version build number directly to any number
+      #
+      # Example:
+      #   >> fvt.changeVersionCode(140)
+      # Arguments:
+      #   p_code: (Integer)
+
       @vCode=p_code.to_i
       commitChanges
     end
   
     def bumpVersionCode(increment = 1)
+      # Increment version build number (default by +1)
+      #
+      # Example:
+      #   >> fvt.bumpVersionCode(1)
+      # Arguments:
+      #   increment: (Integer)  
+
       @vCode= @vCode+increment
       commitChanges
     end
   
-    def bumpVersionName(level = "major", increment)
+    def bumpVersionName(level = "major", increment = 1)
+      # Increment version name semantically (default major version by +1)
+      #
+      # Example:
+      #   >> fvt.bumpVersionName("patch")
+      # Arguments:
+      #   level: ("major","minor","patch")
+      #   increment: (Integer)     
+
       case level
           when "major"
               @vMajor=@vMajor+increment

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flutter_version_tool
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Rim Ganiev
@@ -29,7 +29,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="