Module: DynamodbModel::DbConfig::ClassMethods

Defined in:
lib/dynamodb_model/db_config.rb

Constant Summary collapse

@@db = 
nil

Instance Method Summary collapse

Instance Method Details

#check_dynamodb_local!(endpoint) ⇒ Object

When endoint has been configured to point at dynamodb local: localhost:8000 check if port 8000 is listening and timeout quickly. Or else it takes a for DynamoDB local to time out, about 10 seconds… This wastes less of the users time.



37
38
39
40
41
42
43
44
 
# File 'lib/dynamodb_model/db_config.rb', line 37

def check_dynamodb_local!(endpoint)
  return unless endpoint && endpoint.include?("8000")

  open = port_open?("127.0.0.1", 8000, 0.2)
  unless open
    raise "You have configured your app to use DynamoDB local, but it is not running.  Please start DynamoDB local. Example: brew cask install dynamodb-local && dynamodb-local"
  end
end

#db ⇒ Object 



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/dynamodb_model/db_config.rb', line 22

def db
  return @@db if @@db

  config = db_config
  endpoint = ENV['DYNAMODB_ENDPOINT'] || config['endpoint']
  check_dynamodb_local!(endpoint)

  Aws.config.update(endpoint: endpoint) if endpoint
  @@db ||= Aws::DynamoDB::Client.new
end

#db=(db) ⇒ Object

useful for specs



62
63
64
 
# File 'lib/dynamodb_model/db_config.rb', line 62

def db=(db)
  @@db = db
end

#db_config ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/dynamodb_model/db_config.rb', line 66

def db_config
  return @db_config if @db_config

  if defined?(Jets)
    config_path = "#{Jets.root}config/dynamodb.yml"
    env = Jets.env
  else
    config_path = ENV['DYNAMODB_MODEL_CONFIG'] || "./config/dynamodb.yml"
    env = ENV['DYNAMODB_MODEL_ENV'] || "development"
  end

  config = YAML.load(erb_result(config_path))
  @db_config ||= config[env] || {}
end

#erb_result(path) ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/dynamodb_model/db_config.rb', line 101

def erb_result(path)
  template = IO.read(path)
  begin
    ERB.new(template, nil, "-").result(binding)
  rescue Exception => e
    puts e
    puts e.backtrace if ENV['DEBUG']

    # how to know where ERB stopped? - https://www.ruby-forum.com/topic/182051
    # syntax errors have the (erb):xxx info in e.message
    # undefined variables have (erb):xxx info in e.backtrac
    error_info = e.message.split("\n").grep(/\(erb\)/)[0]
    error_info ||= e.backtrace.grep(/\(erb\)/)[0]
    raise unless error_info # unable to find the (erb):xxx: error line
    line = error_info.split(':')[1].to_i
    puts "Error evaluating ERB template on line #{line.to_s.colorize(:red)} of: #{path.sub(/^\.\//, '').colorize(:green)}"

    template_lines = template.split("\n")
    context = 5 # lines of context
    top, bottom = [line-context-1, 0].max, line+context-1
    spacing = template_lines.size.to_s.size
    template_lines[top..bottom].each_with_index do |line_content, index|
      line_number = top+index+1
      if line_number == line
        printf("%#{spacing}d %s\n".colorize(:red), line_number, line_content)
      else
        printf("%#{spacing}d %s\n", line_number, line_content)
      end
    end
    exit 1 unless ENV['TEST']
  end
end

#get_table_namespace ⇒ Object 



90
91
92
93
94
95
 
# File 'lib/dynamodb_model/db_config.rb', line 90

def get_table_namespace
  return @table_namespace if defined?(@table_namespace)

  config = db_config
  @table_namespace = config['table_namespace']
end

#port_open?(ip, port, seconds = 1) ⇒ Boolean

Thanks: gist.github.com/ashrithr/5305786

Returns:

  • (Boolean) 


47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/dynamodb_model/db_config.rb', line 47

def port_open?(ip, port, seconds=1)
  # => checks if a port is open or not
  Timeout::timeout(seconds) do
    begin
      TCPSocket.new(ip, port).close
      true
    rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, SocketError
      false
    end
  end
rescue Timeout::Error
  false
end

#set_table_namespace(value) ⇒ Object 



97
98
99
 
# File 'lib/dynamodb_model/db_config.rb', line 97

def set_table_namespace(value)
  @table_namespace = value
end

#table_namespace(*args) ⇒ Object 



81
82
83
84
85
86
87
88
 
# File 'lib/dynamodb_model/db_config.rb', line 81

def table_namespace(*args)
  case args.size
  when 0
    get_table_namespace
  when 1
    set_table_namespace(args[0])
  end
end