snippets_for_espanso 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69855241d541438ecb682ccacd4d9833ce592cabe47c5b27c650947af4eb4c83
-  data.tar.gz: 67fb38893fa424ac49f306ba761f4f570530270cf57bda566e0ebfa46f0d5c28
+  metadata.gz: fbacf0b5f9469322538e5f618a97290a647798d7c9fef3a5a930fa60f3a9dfde
+  data.tar.gz: 217c1546e0f1eb04d3fb190b77b1c2e5d133452fadf5f104492eb69603d7372a
 SHA512:
-  metadata.gz: 5c0ffbf3026cdab2df95cd652f30db1f97fc9e5c74ee5247241816285fc4dbcf5f60bd5b0b405f1688fe7ac417a6372fec6727ad72e7fe24c66e723047340327
-  data.tar.gz: c64767846463e5ce4f1fb494a3a85c9005c6fb2da3714b5d57466e66a8de3f10a9d18c6c4af89707c710715dece4a9ba9e5ef1df77ce87f4656240e1b9f9ef0e
+  metadata.gz: 3d4d72670e41bb86a13d9771311795788eec7597014ddb2d675f1e9d8d740f356c87fefdc569f770294e5a6794bcdea6008b66d23a3f0e37c9366af08bd150a9
+  data.tar.gz: 3419f68f18f9406934febfaff7cc6a7290fba479e6fd52372a7633fcc13d59f28fefcf1a498e4af55b3088c1246feda065173108adf8271951105b6f02e5d04e

data/lib/snippet_generator.rb

@@ -1,64 +1,70 @@
-require 'yaml'
+# Some Definitions for the sake of readability.
+
 NEW_LINE="\n"
-QUOTE = '"'
-trigger="whatsup"
-replacement="not much, you?"
-filename='test.yml'
+  QUOTE = '"'
 
 #Just writes matches: at the beginning of file so espanso can read the mapping.
-  def initialize_espanso_yml
-    file_to_write='test.yml'
-    File.open(file_to_write,"a") { |file| file.write('matches:'+NEW_LINE) }
-  end
-#Writes a
-  def single_snippet_export(trigger,replacement)
-    file_to_write='test.yml'
 
-    File.open(file_to_write,"a") { |file| file.write('  - trigger: '+'":'+trigger+QUOTE+NEW_LINE) }
-    File.open(file_to_write,"a") { |file| file.write('    replace: '+QUOTE+replacement+QUOTE+NEW_LINE) }
-  end
+    def initialize_espanso_yml(file_to_write)
+      File.open(file_to_write,"a") { |file| file.write('matches:'+NEW_LINE) }
+    end
 
-  #Takes a string for trigger. formvalues should be arrays within an array.
-  #Parses statement 
-  def picklist_snippet_export(file_to_write)
+#Writes a snippet to file when given trigger and replacement strings.
 
-    form_trigger = "yo"
-    form_variable_name='choices:'
-    form_type = 'choice'
-    formvalues = ['eenie','meenie','minie','moe']
-    statement = "I chose {{choices}}"
-    File.open(file_to_write,"a") { |file| file.write('  - trigger: '+'":'+form_trigger+QUOTE+NEW_LINE) }
-    File.open(file_to_write,"a") { |file| file.write('    form: '+QUOTE+statement+QUOTE+NEW_LINE) }
-    File.open(file_to_write,"a") { |file| file.write('    form_fields:'+NEW_LINE) }
-    File.open(file_to_write,"a") { |file| file.write('      '+form_variable_name+NEW_LINE) }
-    File.open(file_to_write,"a") { |file| file.write('       type: '+ form_type+NEW_LINE) }
-    File.open(file_to_write,"a") { |file| file.write('       values:'+NEW_LINE) }
-    formvalues.each do |value|
-      File.open(file_to_write,"a") { |file| file.write('          - '+QUOTE+value+QUOTE+NEW_LINE) }
+    def single_snippet_export(file_to_write,trigger,replacement)
+      File.open(file_to_write,"a") { |file| file.write('  - trigger: '+'":'+trigger+QUOTE+NEW_LINE) }
+      File.open(file_to_write,"a") { |file| file.write('    replace: '+QUOTE+replacement+QUOTE+NEW_LINE) }
     end
-  end
 
-    def input_form_snippet_export(file_to_write)
+# Create a YAML Comment to separate sections of snippet file.
 
-      form_trigger = "yo"
-      statement = "I chose {{name}}"
-      File.open(file_to_write,"a") { |file| file.write('  - trigger: '+QUOTE+':'+form_trigger+QUOTE+NEW_LINE) }
-      File.open(file_to_write,"a") { |file| file.write('    form: |'+NEW_LINE)}
-      File.open(file_to_write,"a") { |file| file.write('      Hi {{name}}'+NEW_LINE)}
-    end
+def heading_snippet_export(file_to_write)
+  name = "THIS IS AN AWESOME SECTION"
+  File.open(file_to_write,"a") { |file| file.write("#"+ name) }     
+end
 
-    def heading_snippet_export(file_to_write)
-      name = "THIS IS AN AWESOME SECTION"
-      File.open(file_to_write,"a") { |file| file.write("#"+ name) }     
-    end
+# Any input fields should be entered with double brackets around them when passed in as form_statement
+# For example "AJ likes coding in {{language}} and using {{editor}} to write code."
+
+def input_form_snippet_export(form_trigger,form_statement,file_to_write)
+  File.open(file_to_write,"a") { |file| file.write('  - trigger: '+QUOTE+':'+form_trigger+QUOTE+NEW_LINE) }
+  File.open(file_to_write,"a") { |file| file.write('    form: |'+NEW_LINE)}
+  File.open(file_to_write,"a") { |file| file.write('      '+form_statement+NEW_LINE)}
+end
+## ! TO DO: REFACTOR FORM METHODS INTO ONE METHOD which accounts for all cases. Add comments clarifying
+## ! DATA STRUCTURE NEEDED.
+#Takes a string for trigger. form_values should be an array.form_fields should also be of type array.
+#Parses statements and creates picklists based on form fields and values for each field provided 
+
+    def picklist_snippet_export(form_trigger,statement,form_fields,formvalues,file_to_write)
+      form_fields.each do |value|
+        value+':'
+      end
+      form_type = 'choice'
+      File.open(file_to_write,"a") { |file| file.write('  - trigger: '+'":'+form_trigger+QUOTE+NEW_LINE) }
+      File.open(file_to_write,"a") { |file| file.write('    form: '+QUOTE+statement+QUOTE+NEW_LINE) }
+      form_fields.each do |value|
+        File.open(file_to_write,"a") { |file| file.write('    form_fields:'+NEW_LINE) }
+        File.open(file_to_write,"a") { |file| file.write('      '+form_fields+NEW_LINE) }
+        File.open(file_to_write,"a") { |file| file.write('       type: '+ form_type+NEW_LINE) }
+        File.open(file_to_write,"a") { |file| file.write('       values:'+NEW_LINE) }
+        formvalues.each do |value|
+          File.open(file_to_write,"a") { |file| file.write('          - '+QUOTE+value+QUOTE+NEW_LINE) }
+        end
+      end
 
-    def textarea_snippet_export(file_to_write)
-      File.open(file_to_write,"a") { |file| file.write('  - trigger: '+'":'+trigger+QUOTE+NEW_LINE) }
-      File.open(file_to_write,"a") { |file| file.write('    replace: '+QUOTE+replacement+QUOTE+NEW_LINE) }
     end
-  initialize_espanso_yml(filename)
-  single_snippet_export(trigger,replacement)
-  picklist_snippet_export(filename)
-  input_form_snippet_export(filename)
-  heading_snippet_export(filename)
 
+# Creates a snippet with large text box
+
+      def textarea_snippet_export(file_to_write)
+        File.open(file_to_write,"a") { |file| file.write('  - trigger: '+QUOTE+':'+form_trigger+QUOTE+NEW_LINE) }
+        File.open(file_to_write,"a") { |file| file.write('    form: |'+NEW_LINE)}
+        File.open(file_to_write,"a") { |file| file.write('      '+form_statement+NEW_LINE)}
+        File.open(file_to_write,"a") { |file| file.write('        '+field_names+NEW_LINE) }
+        File.open(file_to_write,"a") { |file| file.write('          '+"multiline: true"+NEW_LINE) }
+      end
+
+## Form Generator Method. Will make form that has, .
+## Takes a few arrays as arguments.
+## Form Fields: Just string in array, but in form context represented as {{Form Field Name}}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snippets_for_espanso
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - AJ Markow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-18 00:00:00.000000000 Z
+date: 2020-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yaml
@@ -36,7 +36,7 @@ homepage: https://rubygems.org/gems/snippets_for_espanso
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/ajmarkow/snippets_gem
+  source_code_uri: https://github.com/ajmarkow/snippets_for_espanso
 post_install_message: 
 rdoc_options: []
 require_paths: