hsss 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 487fa212d82812cc8a4857fa40ac9c187f24655f
-  data.tar.gz: adcd2bfd44090494e15c4c5e1244136cfe1597a4
+  metadata.gz: cab7c750dbb0557910fd637a4a29df79cb40db04
+  data.tar.gz: 5286db254bacd9b9288795d52a1c842992ac7b59
 SHA512:
-  metadata.gz: 05afc51d04680fbfe69190cde89918e5838156858c25ce88c6a9001d4eab710808ae623d8d9535283a5c148f446e33ba117a7ea131bd3cfbfebf1a62d3ebfa6b
-  data.tar.gz: 0d1d0db05ab197ab623540b023ed7a5777886a4bb04c6c55b8c411d6fd930a56c0ce5e6cefed2c6a5de470d182354764e80bee64c7f6107c92970a4d33729c7d
+  metadata.gz: 24693aa14136f137c4d20f6472ce88200c288d677260ea25aead6eff9055449ea42de5de0ae4334bce38d90027169275947e0837ce59c8ee659c30bc5f8ef32d
+  data.tar.gz: c2700387cb67d163119f1d081a38ebd2ee8969f550665bed4e012f73e5b19b9a939f7fffbf396350fbfc6912416b8ce900e5b655900381887ae7f74b85bef233

data/README.md

@@ -4,16 +4,24 @@ Hash-Safe Script Splinterer, a Lua Script and hash embedder into C source.
 Good for putting Redis Lua scripts in your C headers.
 ```
 Usage: hsss [options] files
-  --struct [redis_lua_script_t]     C struct name
-  --scripts [redis_lua_scripts]     Scripts variable
-  --hashes [redis_lua_hashes]       Hashes variable
-  --names [redis_lua_script_names]  Script names variable
-  --count [redis_lua_scripts_count] integer script count variable
-  --no-count                        Omit script count variable
-  --each-macro [REDIS_LUA_SCRIPTS_EACH] Iterator macro
-  --no-each                         Omit the iterator macro
-  --no-parse                        Skip using luac to check script syntax
-  --prefix PREFIX                   Prefix default names with this
+        --format [whole|split]       Output as separate or a single struct
+        --struct [redis_lua_scripts_t]
+                                     C struct name
+        --row-struct [redis_lua_script_t]
+                                     Hash+name+script struct for 'whole' format.
+        --scripts [redis_lua_scripts]
+                                     Scripts variable (split or whole format)
+        --hashes [redis_lua_hashes]  Hashes variable (split format)
+        --names [redis_lua_script_names]
+                                     Script names variable (split format)
+        --count [redis_lua_scripts_count]
+                                     integer script count variable
+        --no-count                   Omit script count variable
+        --each-macro [REDIS_LUA_SCRIPTS_EACH]
+                                     Iterator macro
+        --no-each                    Omit the iterator macro
+        --no-parse                   Skip using luac to check script syntax
+        --prefix PREFIX              Prefix default names with this
 ```
 
 ## Example
@@ -34,7 +42,43 @@ redis.call('del', KEYS[1])
 
 ```
 
-running `hsss example/*.lua` outputs
+
+running `hsss example/*.lua` ("whole" format produces
+```c
+// don't edit this please, it was auto-generated by hsss
+// https://github.com/slact/hsss
+
+typedef struct {
+  char *name;
+  char *hash;
+  char *script;
+} redis_lua_script_t;
+
+typedef struct {
+  //deletes first key
+  redis_lua_script_t delete;
+
+  //echoes the first argument
+  redis_lua_script_t echo;
+
+} redis_lua_scripts_t;
+
+static redis_lua_scripts_t redis_lua_scripts = {
+  {"delete", "c6929c34f10b0fe8eaba42cde275652f32904e03",
+   "--deletes first key\n"
+   "redis.call('del', KEYS[1])\n"},
+
+  {"echo", "8f8f934c6049ab4d6337cfa53976893417b268bc",
+   "--echoes the first argument\n"
+   "redis.call('echo', ARGS[1])\n"}
+};
+
+const int redis_lua_scripts_count=2;
+#define REDIS_LUA_SCRIPTS_EACH(script) \
+for((script)=(redis_lua_script_t *)&redis_lua_scripts; (script) < (redis_lua_script_t *)(&redis_lua_scripts + 1); (script)++)
+```
+
+running `hsss --format split example/*.lua` outputs
 ```c
 // don't edit this please, it was auto-generated by hsss
 // https://github.com/slact/hsss
@@ -75,13 +119,19 @@ for((script_src)=(char **)&redis_lua_scripts, (script_hash)=(char **)&redis_lua_
 
 ## Using in your C code
 
-- `EVALSHA`:  
+- `EVALSHA`: 
+  
   ```c
+  //whole format
+  redisAsyncCommand(asyncContext, callback, data, "EVALSHA %s 0", redis_lua_scripts.script_name.hash);
+  
+  //split format
   redisAsyncCommand(asyncContext, callback, data, "EVALSHA %s 0", redis_lua_hashes.script_name);
   ```
   
 - iterator macro, loading scripts  
   ```c
+  //split format:
   
   //privdata for error checking callback
   typedef struct {
@@ -118,6 +168,35 @@ for((script_src)=(char **)&redis_lua_scripts, (script_hash)=(char **)&redis_lua_
   }
   ```
   
+  ```c
+  //whole format:
+  
+  //error checking callback
+  static void redisLoadScriptCallback(redisAsyncContext *c, void *r, void *privdata) {
+    redis_lua_script_t  *script = privdata;
+    redisReply *reply = r;
+    if (reply == NULL) return;
+    switch(reply->type) {
+      case REDIS_REPLY_ERROR:
+        printf("Failed loading redis lua script %s :%s", script->name, reply->str);
+        break;
+      case REDIS_REPLY_STRING:
+        if(nstrncmp(reply->str, script->hash, 40)!=0) {
+          printf("Redis lua script %s has unexpected hash %s (expected %s)", script->name, reply->str, script->hash);
+        }
+        break;
+    }
+  }
+  
+  static void redisInitScripts(redisAsyncContext *c){
+    redis_lua_script_t  *script;
+    
+    REDIS_LUA_SCRIPTS_EACH(script) {
+      redisAsyncCommand(c, redisLoadScriptCallback, script, "SCRIPT LOAD %s", script->script);
+    }
+  }
+  ```
+  
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/exe/hsss

@@ -4,10 +4,12 @@ require "optparse"
 opt={}
 
 arg=OptionParser.new do |opts|
+  opts.on("--format [split|whole]", "Output as separate or a single struct"){|v| opt[:format]= v}
   opts.on("--struct [#{Hsss::DEFAULT_STRUCT_NAME}]", "C struct name"){|v| opt[:struct_name]= v}
-  opts.on("--scripts [#{Hsss::DEFAULT_SCRIPTS_NAME}]", "Scripts variable"){|v| opt[:scripts_struct]=v}
-  opts.on("--hashes [#{Hsss::DEFAULT_HASHES_NAME}]", "Hashes variable"){|v| opt[:hashes_struct]=v}
-  opts.on("--names [#{Hsss::DEFAULT_NAMES_NAME}]", "Script names variable"){|v| opt[:names_struct]=v}
+  opts.on("--row-struct [#{Hsss::DEFAULT_ROW_STRUCT_NAME}]", "Hash+name+script struct for 'whole' format."){|v| opt[:row_struct_name]= v}
+  opts.on("--scripts [#{Hsss::DEFAULT_SCRIPTS_NAME}]", "Scripts variable (split or whole format)"){|v| opt[:scripts_struct]=v}
+  opts.on("--hashes [#{Hsss::DEFAULT_HASHES_NAME}]", "Hashes variable (split format)"){|v| opt[:hashes_struct]=v}
+  opts.on("--names [#{Hsss::DEFAULT_NAMES_NAME}]", "Script names variable (split format)"){|v| opt[:names_struct]=v}
   opts.on("--count [#{Hsss::DEFAULT_COUNT_NAME}]", "integer script count variable"){|v| opt[:count_name]=v}
   opts.on("--no-count", "Omit script count variable"){opt[:skip_count]=true}
   opts.on("--each-macro [#{Hsss::DEFAULT_ITER_MACRO_NAME}]", "Iterator macro"){|v| opt[:iter_macro_name]=v}
@@ -24,7 +26,15 @@ arg.version=Hsss::VERSION
 
 rest = arg.parse!
 
-hsss = Hsss::Hsss.new(rest, opt)
+case opt[:format]
+when nil, "split"
+  hsss = Hsss::CSplit.new(rest, opt)
+when "whole"
+  hsss = Hsss::CWhole.new(rest, opt)
+else
+  STDERR.puts "Invalid format #{opt[:format]}."
+  exit 1
+end
 
 exit 1 if hsss.failed?
 

data/lib/hsss/version.rb

@@ -1,3 +1,3 @@
 module Hsss
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/lib/hsss.rb

@@ -1,22 +1,23 @@
 require "hsss/version"
 require 'digest/sha1'
-
+require "pry"
 module Hsss
-  DEFAULT_STRUCT_NAME="redis_lua_script_t"
+  DEFAULT_STRUCT_NAME="redis_lua_scripts_t"
+  DEFAULT_ROW_STRUCT_NAME="redis_lua_script_t"
   DEFAULT_HASHES_NAME="redis_lua_hashes"
   DEFAULT_NAMES_NAME="redis_lua_script_names"
   DEFAULT_SCRIPTS_NAME="redis_lua_scripts"
   DEFAULT_COUNT_NAME="redis_lua_scripts_count"
   DEFAULT_ITER_MACRO_NAME="REDIS_LUA_SCRIPTS_EACH"
   
-  class Hsss
+  class COutput
     EXT="lua"
+    attr_accessor :struct_name, :hashes_struct, :names_struct, :scripts_struct, :count_name, :iter_macro_name, :row_struct_name
     
-    attr_accessor :struct_name, :hashes_struct, :names_struct, :scripts_struct, :count_name, :iter_macro_name
     def initialize(files, opt={})
       @scripts={}
-      
       { struct_name: DEFAULT_STRUCT_NAME, 
+        row_struct_name: DEFAULT_ROW_STRUCT_NAME,
         hashes_struct: DEFAULT_HASHES_NAME,
         names_struct: DEFAULT_NAMES_NAME,
         scripts_struct: DEFAULT_SCRIPTS_NAME,
@@ -45,28 +46,6 @@ module Hsss
         end
       end
       
-      @cout= <<-EOS.gsub(/^ {8}/, '')
-        // don't edit this please, it was auto-generated by hsss
-        // https://github.com/slact/hsss
-        
-        typedef struct {
-        %s
-        } #{struct_name};
-        
-        static #{struct_name} #{hashes_struct} = {
-        %s
-        };
-        
-        static #{struct_name} #{names_struct} = {
-        %s
-        };
-        
-        static #{struct_name} #{scripts_struct} = {
-        %s
-        };
-        
-      EOS
-      
       @struct=[]
       @name_table=[]
       @script_table=[]
@@ -76,7 +55,7 @@ module Hsss
         name=v.first
         script=v.last
         
-        @name_table << "  \"#{name}\","
+        @name_table << name
         
         str=[]
         for l in script.lines do
@@ -84,14 +63,13 @@ module Hsss
           break unless cmt
           str << "  //#{cmt[1]}"
         end
-        str << "  char *#{name};\n"
+        str << "  #{script_name_line(name)}\n"
         @struct << str.join("\n")
         
-        @script_table << "  //#{name}\n#{cquote(script)}"
+        @script_table << script_string(name, script)
         
-        @hashed_table << "  \"#{Digest::SHA1.hexdigest script}\""
+        @hashed_table << Digest::SHA1.hexdigest(script)
       end
-      
     end
     
     def check_script(path)
@@ -100,20 +78,60 @@ module Hsss
       ret
     end
     
-    def cquote(str)
+    def cquote(str, line_start="")
       out=[]
       str.each_line do |l|
         l.sub! "\n", "\\n"
         l.gsub! '"', '\"'
-        l.gsub! /^(.*)$/, "  \"\\1\""
+        l.gsub! /^(.*)$/, "#{line_start}\"\\1\""
         out << l
       end
       out.join "\n"
     end
     
+    def failed?
+      @failed
+    end
+  end
+  
+  class CSplit < COutput
+    
+    def initialize(files, opt={})
+      super
+      @cout= <<-EOS.gsub(/^ {8}/, '')
+        // don't edit this please, it was auto-generated by hsss
+        // https://github.com/slact/hsss
+        
+        typedef struct {
+        %s
+        } #{struct_name};
+        
+        static #{struct_name} #{hashes_struct} = {
+        %s
+        };
+        
+        static #{struct_name} #{names_struct} = {
+        %s
+        };
+        
+        static #{struct_name} #{scripts_struct} = {
+        %s
+        };
+        
+      EOS
+    end
+    
+    def script_name_line(name)
+      "char *#{name};"
+    end
+    
+    def script_string(name, script)
+      "  //#{name}\n#{cquote(script, "  ")}"
+    end
+    
     def to_s
       if @scripts.count > 0
-        out=sprintf @cout, @struct.join("\n"), @hashed_table.join(",\n"),  @name_table.join("\n"), @script_table.join(",\n\n")
+        out=sprintf @cout, @struct.join("\n"), @hashed_table.map{|v|"  \"#{v}\""}.join(",\n"),  @name_table.map{|v|"  \"#{v}\","}.join("\n"), @script_table.join(",\n\n")
       else
         out="//nothing here\n"
       end
@@ -130,8 +148,71 @@ module Hsss
       out
     end
     
+
+  end
+  
+  
+  
+  class CWhole < COutput
+    EXT="lua"
+    
+    def initialize(files, opt={})
+      super
+      @cout= <<-EOS.gsub(/^ {8}/, '')
+        // don't edit this please, it was auto-generated by hsss
+        // https://github.com/slact/hsss
+        
+        typedef struct {
+          char *name;
+          char *hash;
+          char *script;
+        } #{row_struct_name};
+        
+        typedef struct {
+        %s
+        } #{struct_name};
+        
+        static #{struct_name} #{scripts_struct} = {
+        %s
+        };
+        
+      EOS
+      
+    end
+    
+    def script_name_line(name) 
+      "#{row_struct_name} #{name};"
+    end
+    def script_string(name, script)
+      cquote(script, "   ")
+    end
+    def to_s
+      if @scripts.count > 0
+        scrapts=[]
+        for i in 0...@scripts.count do
+          scrapts<< "  {\"#{@name_table[i]}\", \"#{@hashed_table[i]}\",\n#{@script_table[i]}}"
+        end
+        out=sprintf @cout, @struct.join("\n"), scrapts.join(",\n\n")
+      else
+        out="//nothing here\n"
+      end
+      
+      out << "const int #{@count_name}=#{@scripts.count};\n" if @include_count
+      
+      if @include_iter_macro
+        macro = []
+        macro << "#define #{iter_macro_name}(script) \\"
+        macro << "for((script)=(#{row_struct_name} *)&#{scripts_struct}; (script) < (#{row_struct_name} *)(&#{scripts_struct} + 1); (script)++) "
+        out << macro.join("\n")
+      end
+      
+      out
+    end
+    
     def failed?
       @failed
     end
   end
+  
+  
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hsss
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Leo P.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-18 00:00:00.000000000 Z
+date: 2016-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler